​

AGENTS

​

Project Overview

​

Repository Structure

• docs/ — Main documentation content (MDX pages such as welcome.mdx, building-blocks.mdx, and deeper topic folders).
• blog/ — Blog landing page and post MDX files.
• snippets/ — Reusable JSX/MDX snippets (e.g., blog card components, post metadata list).
• docs.json — Mintlify configuration (navigation tabs, groups, redirects, theme, and SEO).
• .vale.ini / styles/ — Vale linting configuration and vocabulary/style rules.
• images/, static/, logo/ — Media and static assets.

​

Development Guidelines

• Use MDX for documentation and blog content. Follow the existing frontmatter pattern (title, description, optional icon or mode).
• Keep navigation up to date by editing docs.json when adding or removing pages.
• Reuse snippets/components from snippets/ rather than duplicating logic in MDX pages.
• Maintain clear, product-focused language that matches the style in existing docs.

​

Code Patterns (if applicable)

• MDX pages use Mintlify components such as CardGroup, Card, Steps, Note, Tip, AccordionGroup, and Frame.
• Blog index imports JSX snippets for card rendering and uses a shared posts export (snippets/posts.mdx).

​

Quality Standards

• Ensure MDX frontmatter is complete and accurate.
• Verify links and cross-references (e.g., /docs/...) when updating content.
• Keep formatting consistent with existing docs (headings, lists, component usage).
• Run Vale or follow its guidance if linting rules are enforced (.vale.ini).

​

Critical Rules

• Do not remove or rename pages referenced in docs.json without updating navigation/redirects.
• Preserve Mintlify-specific frontmatter keys and component syntax.
• Do not place secrets or credentials in documentation content.

​

Common Tasks

• Add a new documentation page: create a new MDX file under docs/, add it to the appropriate group in docs.json, and include frontmatter.
• Add a blog post: create a new MDX file under blog/, update snippets/posts.mdx, and confirm the blog index renders it.
• Update navigation/redirects: edit docs.json and verify paths match file locations.

​

Reference Examples

• docs/welcome.mdx — Landing page with CardGroup and Frame components.
• docs/building-blocks.mdx — Multi-section page using Steps, Note, and Tip.
• blog/index.mdx — Blog landing page importing snippets.
• snippets/blog-cards.jsx and snippets/posts.mdx — Shared blog rendering logic and metadata.

​

Additional Resources

• Mintlify docs.json reference: https://mintlify.com/docs.json
• Mintlify MDX components: https://mintlify.com/docs/components
• Vale documentation: https://vale.sh/docs