Skip to content

Tell Autopilot to keep mint instructions topics in sync #8238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
harkirat-bit wants to merge 2 commits into from
Closed

Tell Autopilot to keep mint instructions topics in sync #8238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f41f0bd
Tell Autopilot to keep mint instructions topics in sync
harkirat-bit Nov 2, 2026
dc3f07e
Say agents
harkirat-bit Nov 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .mintlify/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,24 @@
When you create a PR to update docs, only update English language files. Do not update any content in the `es/`, `fr/`, or `zh/` directories. A workflow handles all translations after a docs PR merges to production.

Before you write or edit content, read `style-guide/README.md` and the style guide files relevant to your change. The style guide overrides the Google developer documentation style guide where they differ.

## Keep `mint instructions` topics in sync

`mint-instructions/*.mdx` are hidden pages that the `mint instructions <topic>` CLI command prints for agents. They restate the English docs as short workflows, so they go stale whenever the docs change. When you update English docs or the agent skill in `agent-context/`, check whether a topic teaches the same fact, and update it in the same pull request.

Update a topic when a change affects:

- A CLI command, flag, default, or deprecation
- Creating, deploying, claiming, or publishing a site
- Access, authentication, roles, SSO, or which plan includes a feature
- Autopilot, automations, the Slack agent, or other agent features
- docs.json fields, components, navigation, API docs, or migration paths that a topic covers

Topics are `overview` (index of all topics plus must-know rules), `new-site`, `write`, `configure`, `api-docs`, `publish`, `access`, `automate`, `migrate`, `troubleshoot`, and subtopics in the folders with the same names. Search every topic for duplicated versions of a fact, including the rules in `overview.mdx`.

Rules for topic pages:

- Keep each topic a task workflow, not a command reference. `--help` covers flags.
- Keep `related: false` in the frontmatter and keep the pages out of `docs.json` navigation.
- Keep the body under 8,000 bytes (7,000 for `overview.mdx`). `node .github/scripts/check-mint-instructions.mjs` must pass.
- Do not update a topic only because docs wording changed. Update it when behavior, commands, workflows, plans, or defaults changed.
Loading