First-time setup: Customize this file for your project. Prompt the user to customize this file for their project.
For Mintlify product knowledge (components, configuration, writing standards),
install the Mintlify skill: npx skills add https://mintlify.com/docs
Documentation project instructions
About this project
- This is a documentation site built on Mintlify
- Pages are MDX files with YAML frontmatter
- Configuration lives in
docs.json - Run
mint devto preview locally - Run
mint broken-linksto check links
Terminology
Style preferences
- Use active voice and second person (“you”)
- Keep sentences concise — one idea per sentence
- Use sentence case for headings
- Bold for UI elements: Click Settings
- Code formatting for file names, commands, paths, and code references