---name: Update changelogon: cron: "0 9 * * 1"context: - repo: your-org/your-productautomerge: false---Review all changes since the last changelog update. Draft a new changelog post with any new features, bug fixes, or breaking changes.Include information about what changed and how it affects users.Do not include any internal-only information or minor changes like bumping package versions or updating documentation.Success criteria: Someone who reads the changelog knows the most up to date information about the product including what changed and whether or not it affects them.
---name: Draft docs for new featureson: push: - repo: your-org/your-product branch: maincontext: - repo: your-org/your-docsautomerge: false---Review the diff from the last merged PR in `your-org/your-product`. Identify any new features, APIs, or other changes that require documentation.For each new addition, draft documentation updates that explain what it does, when to use it, and how to configure it. Include a code example where relevant.Success criteria: After reading any new or updated documentation, users understand what the feature is, if it applies to tasks they do, and how to use it.## Important- Only document changes that affect end users. Skip internal refactors or dependency updates.- Match the style and structure of existing docs pages.
---name: Style auditon: push: - repo: your-org/your-docs branch: mainautomerge: false---Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`.Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes.Success criteria:- All style violations have a proposed resolution.- No new style violations are introduced.## Important- Do not change content meaning. Only correct style violations.- Skip any files in language subdirectories (`es/`, `fr/`, `zh/`).
当更改被推送到你的产品存储库时运行，用于使 API 参考页面与产品代码保持同步。当端点或参数发生变更时，此工作流会更新文档中对应的内容。
.mintlify/workflows/update-api-reference.md
---name: Update API referenceon: push: - repo: your-org/your-product branch: maincontext: - repo: your-org/your-docsautomerge: false---Review the diff from the last merged PR in `your-org/your-product` for changes to API endpoints, parameters, response shapes, or error codes.Update the corresponding API specifications or pages in the docs to reflect the changes. Include updated parameter descriptions, type information, and examples where affected.Success criteria: All API specifications and pages are up to date with the changes in the product repository.## Important- If a parameter or endpoint was removed, mark it as deprecated rather than deleting it unless the code explicitly removes it with no deprecation period.- If no API changes were introduced, do nothing.
---name: SEO and metadata auditon: cron: "0 9 * * 1"automerge: false---Audit all MDX files in the docs for SEO and metadata quality. Check for:- Missing or empty `title` frontmatter- Titles that are too long (over 60 characters) — long titles are truncated in search result snippets- Titles that follow a boilerplate pattern like "PageType - Name" without describing the specific content of the page- Missing or empty `description` frontmatter- Descriptions that are too short (under 130 characters) — short descriptions are frequently ignored by Google in favor of auto-generated snippets- Descriptions that are too long (over 160 characters)- Pages that share an identical description with other pages — each page needs a unique descriptionOpen a pull request with improvements for any issues found.When writing titles: be descriptive and specific about what the page covers. Avoid generic patterns like "Overview - Product Name". Target 50-60 characters.When writing descriptions: summarize what the specific page covers in plain language. Include 2-3 terms a user would actually search for. Never reuse the same description across pages. Target 130-155 characters.Success criteria: All pages have a unique title under 60 characters that describes the specific content, and a unique description between 130 and 160 characters.## Important- Only update frontmatter. Do not change page content.- If all pages have complete and reasonable metadata, do nothing.
---name: Weekly changelogon: cron: "0 9 * * 1"context: - repo: your-org/your-productautomerge: falsenotify: slack: channels: - documentation users: - tech-writer---Review all merged PRs in `your-org/your-product` from the past week. Draft a changelog entry summarizing new features, bug fixes, and breaking changes.Success criteria: The changelog accurately reflects the week's changes and is ready for review.
