Skip to content

Commit 56b861d

Browse files
committed
different CLAUDE.md approach
1 parent dfa112d commit 56b861d

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

.claude/CLAUDE.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,46 @@
11
# Mintlify documentation
22

3+
## Working relationship
4+
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
5+
- ALWAYS ask for clarification rather than making assumptions
6+
- NEVER lie, guess, or make up information
7+
38
## Project context
4-
- Official documentation site for Mintlify platform
59
- Format: MDX files with YAML frontmatter
610
- Config: docs.json for navigation, theme, settings
7-
- Images: /images/ directory with light/dark variants
11+
- Components: Mintlify components
812

913
## Content strategy
10-
- Use MCP search before writing new content
14+
- Document just enough for user success - not too much, not too little
15+
- Prioritize accuracy and usability of information
16+
- Make content evergreen when possible
17+
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
1118
- Check existing patterns for consistency
12-
- Cross-link to related information when it helps users accomplish tasks
13-
- Maintain examples that work for all Mintlify users
19+
- Start by making the smallest reasonable changes
1420

15-
## Frontmatter requirements
21+
## Frontmatter requirements for pages
1622
- title: Clear, descriptive page title
1723
- description: Concise summary for SEO/navigation
18-
- icon: Appropriate icon matching content type
1924

2025
## Writing standards
2126
- Second-person voice ("you")
2227
- Prerequisites at start of procedural content
23-
- Test all code examples
28+
- Test all code examples before publishing
29+
- Match style and formatting of existing pages
2430
- Include both basic and advanced use cases
25-
- Add troubleshooting for complex features
26-
27-
## Components (quick reference)
28-
- Callouts: `<Info>`, `<Warning>`, `<Tip>`, `<Note>`, `<Check>`, `<Danger>`
29-
- Layout: `<Frame>`, `<CodeGroup>`, `<Steps>`, `<Tabs>`
30-
31-
## File standards
3231
- Language tags on all code blocks
3332
- Alt text on all images
3433
- Relative paths for internal links
35-
- Light/dark image variants where applicable
3634

37-
## Do Not
35+
## Git workflow
36+
- NEVER use --no-verify when committing
37+
- Ask how to handle uncommitted changes before starting
38+
- Create a new branch when no clear branch exists for changes
39+
- Commit frequently throughout development
40+
- NEVER skip or disable pre-commit hooks
41+
42+
## Do not
3843
- Skip frontmatter on any MDX file
3944
- Use absolute URLs for internal links
4045
- Include untested code examples
41-
- Break backward compatibility without migration notes
46+
- Make assumptions - always ask for clarification

0 commit comments

Comments
 (0)