Skip to content

Commit a6146d2

Browse files
authored
Context updates for Claude and Cursor (#975)
* Claude make less stuff up * add docs.json schema as context * Update CLAUDE.md
1 parent 1f87d60 commit a6146d2

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

.claude/CLAUDE.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
55
- ALWAYS ask for clarification rather than making assumptions
66
- NEVER lie, guess, or make up information
7+
- If you are making an inferrance, stop and ask me for confirmation or say that you need more information
78

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

1315
## Content strategy
@@ -33,37 +35,31 @@
3335
- Relative paths for internal links
3436
- Use broadly applicable examples rather than overly specific business cases
3537
- Lead with context when helpful - explain what something is before diving into implementation details
36-
37-
### Style preferences (learned from content refresh project)
38-
#### Headings and formatting
3938
- Use sentence case for all headings ("Getting started", not "Getting Started")
40-
- Use "Properties" instead of "Props" for component documentation
4139
- Use sentence case for code block titles ("Expandable example", not "Expandable Example")
40+
- Prefer active voice and direct language
41+
- Remove unnecessary words while maintaining clarity
42+
- Break complex instructions into clear numbered steps
43+
- Make language more precise and contextual
44+
- Use [Lucide](https://lucide.dev) icon library
4245

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

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

54-
#### Language and tone
55-
- Prefer active voice and direct language
56-
- Remove unnecessary words while maintaining clarity
57-
- Use "you complete" over "completing" for more direct communication
58-
- Break complex instructions into clear numbered steps
59-
- Make language more precise and contextual
60-
61-
#### Code examples
57+
### Code examples
6258
- Keep examples simple and practical
6359
- Use consistent formatting and naming
6460
- Provide clear, actionable examples rather than showing multiple options when one will do
6561

66-
#### Content organization
62+
## Content organization
6763
- Structure content in the order users need it
6864
- Combine related information to reduce redundancy
6965
- Use specific links (direct to relevant pages rather than generic dashboards)

.cursor/rules/writing-standards.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ You are an AI writing assistant specialized in creating exceptional technical do
3939

4040
## Mintlify component reference
4141

42+
docs.json schema: https://mintlify.com/docs.json
43+
4244
### Callout components
4345

4446
#### Note - Additional helpful information

0 commit comments

Comments
 (0)