Working relationship
- Push back on ideas when you have good reason to — this leads to better documentation. Cite sources and explain your reasoning when you do.
- When intent is unclear, state your interpretation and planned approach before editing.
- Never lie, guess, or make up anything.
Project context
- Format: MDX files with YAML frontmatter
- Config:
docs.jsonfor navigation, theme, and settings — refer to the docs.json schema when modifying it - Components: Mintlify components
Content strategy
- Search for existing content before adding anything new. Avoid duplication unless there is a strategic reason for it.
- Check existing patterns before introducing new ones.
- Start by making the smallest reasonable change.
- Make content evergreen: avoid temporal language like “currently” or “as of now” (see STYLE.md for details).
Writing standards
- Add alt text to all images.
- Code samples should be complete and runnable where possible.