|
| 1 | +# Documentation project context |
| 2 | + |
| 3 | +## Project overview |
| 4 | +This is a Mintlify documentation site built with MDX files and configured |
| 5 | +via docs.json. The site follows Mintlify's documentation framework with |
| 6 | +structured navigation, components, and theming. |
| 7 | + |
| 8 | +## File structure and conventions |
| 9 | +- **Main config**: `docs.json` - contains navigation, theme settings, and |
| 10 | +site configuration |
| 11 | +- **Content**: All documentation is in `.mdx` files with frontmatter |
| 12 | +- **Structure**: Organized in folders matching the navigation structure |
| 13 | +- **Images**: Stored in `/images/` directory with light/dark variants |
| 14 | +- **Components**: Reusable components documented in `/components/` folder |
| 15 | + |
| 16 | +## Documentation standards |
| 17 | +- Use MDX format with YAML frontmatter containing: title, description, |
| 18 | +icon |
| 19 | +- Follow existing navigation structure defined in docs.json |
| 20 | +- Use Mintlify components: `<Info>`, `<Warning>`, `<Tip>`, `<Note>`, |
| 21 | +`<Check>`, `<Danger>` |
| 22 | +- Include light/dark mode image variants when applicable |
| 23 | +- Use `<Frame>` component for image containers |
| 24 | +- Code blocks should specify language for syntax highlighting |
| 25 | + |
| 26 | +## Writing style |
| 27 | +- Clear, concise technical writing |
| 28 | +- Step-by-step guides with numbered lists |
| 29 | +- Use callouts for important information |
| 30 | +- Include prerequisites sections where needed |
| 31 | +- Provide code examples and configuration snippets |
| 32 | + |
| 33 | +## Common components |
| 34 | +- `<Info>`, `<Warning>`, `<Tip>`, `<Note>`, `<Check>`, `<Danger>` for |
| 35 | +callouts |
| 36 | +- `<Frame>` for image containers |
| 37 | +- `<RequestExample>` for code examples |
| 38 | +- Custom React components (like HeroCard in index.mdx) |
| 39 | + |
| 40 | +## Key areas |
| 41 | +- Getting started guides (quickstart, installation) |
| 42 | +- API documentation and playground setup |
| 43 | +- Component documentation |
| 44 | +- Integration guides |
| 45 | +- Settings and configuration |
| 46 | +- Authentication and personalization |
| 47 | + |
| 48 | +## When editing existing files |
| 49 | +- Maintain consistent frontmatter structure |
| 50 | +- Follow existing component usage patterns |
| 51 | +- Keep navigation structure aligned with docs.json |
| 52 | +- Use appropriate callout types for different message types |
| 53 | +- Include relevant icons in frontmatter |
0 commit comments