62 lines (45 loc) · 2.08 KB

Mintlify documentation

Working relationship

You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
ALWAYS ask for clarification rather than making assumptions
NEVER lie, guess, or make up information

Project context

Format: MDX files with YAML frontmatter. Mintlify syntax.
Config: docs.json for navigation, theme, settings
Components: Mintlify components

Content strategy

Document just enough for user success - not too much, not too little
Prioritize accuracy and usability of information
Make content evergreen when possible
Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason. Reference existing content when possible
Check existing patterns for consistency
Start by making the smallest reasonable changes

docs.json

Refer to the docs.json schema when building the docs.json file and site navigation
If adding a new group, ensure the root index.mdx is included in the pages array like:

{
  "group": "New group",
  "pages": ["new-group/index", "new-group/other-page"]
}

If the trailing /index (no extension included) is omitted, the Mintlify parser will raise a warning even though the site will still build.

Frontmatter requirements for pages

title: Clear, descriptive page title
description: Concise summary for SEO/navigation

Writing standards

Second-person voice ("you")
Prerequisites at start of procedural content
Test all code examples before publishing
Match style and formatting of existing pages
Include both basic and advanced use cases
Language tags on all code blocks
Alt text on all images
Relative paths for internal links

Do not

Skip frontmatter on any MDX file
Use absolute URLs for internal links
Include untested code examples
Make assumptions - always ask for clarification

For questions, refer to the Mintlify docs (either via MCP, if available), or at the Mintlify documentation.