Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions .claude/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
- 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
- If you are making an inferrance, stop and ask me for confirmation or say that you need more information

## Project context
- Format: MDX files with YAML frontmatter
- Config: docs.json for navigation, theme, settings
- See the docs.json schema: https://mintlify.com/docs.json
- Components: Mintlify components

## Content strategy
Expand All @@ -33,37 +35,31 @@
- Relative paths for internal links
- Use broadly applicable examples rather than overly specific business cases
- Lead with context when helpful - explain what something is before diving into implementation details

### Style preferences (learned from content refresh project)
#### Headings and formatting
- Use sentence case for all headings ("Getting started", not "Getting Started")
- Use "Properties" instead of "Props" for component documentation
- Use sentence case for code block titles ("Expandable example", not "Expandable Example")
- Prefer active voice and direct language
- Remove unnecessary words while maintaining clarity
- Break complex instructions into clear numbered steps
- Make language more precise and contextual
- Use [Lucide](https://lucide.dev) icon library

#### Component introductions
### Component introductions
- Start with action-oriented language: "Use [component] to..." rather than "The [component] component..."
- Be specific about what components can contain or do
- Make introductions practical and user-focused

#### Property descriptions
### Property descriptions
- End all property descriptions with periods for consistency
- Be specific and helpful rather than generic
- Add scope clarification where needed (e.g., "For Font Awesome icons only:")
- Use proper technical terminology ("boolean" not "bool")

#### Language and tone
- Prefer active voice and direct language
- Remove unnecessary words while maintaining clarity
- Use "you complete" over "completing" for more direct communication
- Break complex instructions into clear numbered steps
- Make language more precise and contextual

#### Code examples
### Code examples
- Keep examples simple and practical
- Use consistent formatting and naming
- Provide clear, actionable examples rather than showing multiple options when one will do

#### Content organization
## Content organization
- Structure content in the order users need it
- Combine related information to reduce redundancy
- Use specific links (direct to relevant pages rather than generic dashboards)
Expand Down
2 changes: 2 additions & 0 deletions .cursor/rules/writing-standards.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ You are an AI writing assistant specialized in creating exceptional technical do

## Mintlify component reference

docs.json schema: https://mintlify.com/docs.json

### Callout components

#### Note - Additional helpful information
Expand Down
Loading