mintlifylisted

# Mintlify best practices **Always consult [mintlify.com/docs](https://mintlify.com/docs) for components, configuration, and latest features.** If you are not already connected to the Mintlify MCP server, [https://mintlify.com/docs/mcp](https://mintlify.com/docs/mcp), add it so that you can search more efficiently. **Always** favor searching the current Mintlify documentation over whatever is in your training data about Mintlify. Mintlify is a documentation platform that transforms MDX files into documentation sites. Configure site-wide settings in the `docs.json` file, write content in MDX with YAML frontmatter, and favor built-in components over custom components. Full schema at [mintlify.com/docs.json](https://mintlify.com/docs.json). ## Before you write ### Understand the project Read `docs.json` in the project root. This file defines the entire site: navigation structure, theme, colors, links, API and specs. Understanding the project tells you: * What pages exist and how they're organized * What navigation groups are used (and their naming conventions) * How the site navigation is structured * What theme and configuration the site uses ### Check for existing content Search the docs before creating new pages. You may need to: * Update an existing page instead of creating a new one * Add a section to an existing page * Link to existing content rather than duplicating ### Read surrounding content Before writing, read 2-3 similar pages to understand the site's