diff options
Diffstat (limited to 'packages/docs/ai-tools/claude-code.mdx')
| -rw-r--r-- | packages/docs/ai-tools/claude-code.mdx | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/packages/docs/ai-tools/claude-code.mdx b/packages/docs/ai-tools/claude-code.mdx index bdc4e04b5..4039c6e0e 100644 --- a/packages/docs/ai-tools/claude-code.mdx +++ b/packages/docs/ai-tools/claude-code.mdx @@ -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: - ```bash - npm install -g @anthropic-ai/claude-code +```bash +npm install -g @anthropic-ai/claude-code ``` 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: -````markdown +```markdown # Mintlify documentation ## Working relationship + - 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 ## Project context + - Format: MDX files with YAML frontmatter - Config: docs.json for navigation, theme, settings - Components: Mintlify components ## Content strategy + - Document just enough for user success - not too much, not too little - Prioritize accuracy and usability of information - 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 ## Frontmatter requirements for pages + - title: Clear, descriptive page title - description: Concise summary for SEO/navigation ## Writing standards + - Second-person voice ("you") - Prerequisites at start of procedural content - 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 ## Git workflow + - NEVER use --no-verify when committing - Ask how to handle uncommitted changes before starting - 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 ## Do not + - Skip frontmatter on any MDX file - Use absolute URLs for internal links - Include untested code examples - Make assumptions - always ask for clarification -```` +``` |