|
@@ -14,8 +14,8 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl
|
|
|
|
|
|
|
|
1. Install Claude Code globally:
|
|
1. Install Claude Code globally:
|
|
|
|
|
|
|
|
- ```bash
|
|
|
|
|
- npm install -g @anthropic-ai/claude-code
|
|
|
|
|
|
|
+```bash
|
|
|
|
|
+npm install -g @anthropic-ai/claude-code
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
2. Navigate to your docs directory.
|
|
2. Navigate to your docs directory.
|
|
@@ -26,20 +26,23 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl
|
|
|
|
|
|
|
|
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
|
|
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
|
|
|
|
|
|
|
|
-````markdown
|
|
|
|
|
|
|
+```markdown
|
|
|
# Mintlify documentation
|
|
# Mintlify documentation
|
|
|
|
|
|
|
|
## Working relationship
|
|
## Working relationship
|
|
|
|
|
+
|
|
|
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
|
|
- 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
|
|
- ALWAYS ask for clarification rather than making assumptions
|
|
|
- NEVER lie, guess, or make up information
|
|
- NEVER lie, guess, or make up information
|
|
|
|
|
|
|
|
## Project context
|
|
## Project context
|
|
|
|
|
+
|
|
|
- Format: MDX files with YAML frontmatter
|
|
- Format: MDX files with YAML frontmatter
|
|
|
- Config: docs.json for navigation, theme, settings
|
|
- Config: docs.json for navigation, theme, settings
|
|
|
- Components: Mintlify components
|
|
- Components: Mintlify components
|
|
|
|
|
|
|
|
## Content strategy
|
|
## Content strategy
|
|
|
|
|
+
|
|
|
- Document just enough for user success - not too much, not too little
|
|
- Document just enough for user success - not too much, not too little
|
|
|
- Prioritize accuracy and usability of information
|
|
- Prioritize accuracy and usability of information
|
|
|
- Make content evergreen when possible
|
|
- Make content evergreen when possible
|
|
@@ -48,10 +51,12 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
|
|
|
- Start by making the smallest reasonable changes
|
|
- Start by making the smallest reasonable changes
|
|
|
|
|
|
|
|
## Frontmatter requirements for pages
|
|
## Frontmatter requirements for pages
|
|
|
|
|
+
|
|
|
- title: Clear, descriptive page title
|
|
- title: Clear, descriptive page title
|
|
|
- description: Concise summary for SEO/navigation
|
|
- description: Concise summary for SEO/navigation
|
|
|
|
|
|
|
|
## Writing standards
|
|
## Writing standards
|
|
|
|
|
+
|
|
|
- Second-person voice ("you")
|
|
- Second-person voice ("you")
|
|
|
- Prerequisites at start of procedural content
|
|
- Prerequisites at start of procedural content
|
|
|
- Test all code examples before publishing
|
|
- Test all code examples before publishing
|
|
@@ -62,6 +67,7 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
|
|
|
- Relative paths for internal links
|
|
- Relative paths for internal links
|
|
|
|
|
|
|
|
## Git workflow
|
|
## Git workflow
|
|
|
|
|
+
|
|
|
- NEVER use --no-verify when committing
|
|
- NEVER use --no-verify when committing
|
|
|
- Ask how to handle uncommitted changes before starting
|
|
- Ask how to handle uncommitted changes before starting
|
|
|
- Create a new branch when no clear branch exists for changes
|
|
- Create a new branch when no clear branch exists for changes
|
|
@@ -69,8 +75,9 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
|
|
|
- NEVER skip or disable pre-commit hooks
|
|
- NEVER skip or disable pre-commit hooks
|
|
|
|
|
|
|
|
## Do not
|
|
## Do not
|
|
|
|
|
+
|
|
|
- Skip frontmatter on any MDX file
|
|
- Skip frontmatter on any MDX file
|
|
|
- Use absolute URLs for internal links
|
|
- Use absolute URLs for internal links
|
|
|
- Include untested code examples
|
|
- Include untested code examples
|
|
|
- Make assumptions - always ask for clarification
|
|
- Make assumptions - always ask for clarification
|
|
|
-````
|
|
|
|
|
|
|
+```
|