Write documentation with Claude Code

Configure Claude Code with CLAUDE.md project instructions to write, review, and update your Mintlify documentation following your style guide.

Claude Code is an agentic command line tool that can help you maintain your documentation. It can write new content, review existing pages, and keep docs up to date.

You can train Claude Code to understand your documentation standards and workflows by adding a CLAUDE.md file to your project and refining it over time.

Prerequisites:

• Active Claude subscription (Pro, Max, or API access)

Setup:

1. Install Claude Code:

npm install -g @anthropic-ai/claude-code

2. Navigate to your docs directory.
3. (Optional) Add the CLAUDE.md file below to your project.
4. Run claude to start.

Install the Mintlify skill for context on project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Add the Mintlify Docs MCP server for documentation search:

https://mintlify.com/docs/mcp

Add the Mintlify MCP server for dashboard access and content management:

https://mcp.mintlify.com

To confirm your setup, send a prompt to Claude Code like List the Mintlify components you can use.

Save a CLAUDE.md file at the root of your docs directory to help Claude Code understand your project. This file trains Claude Code on your documentation standards, preferences, and workflows. See Manage Claude's memory in the Anthropic docs for more information.

Copy this example template or make changes for your docs specifications:

# 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 anything

## 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
- Make content evergreen when possible
- Search for existing content before adding anything new. Avoid duplication unless it is done for a strategic reason
- Check existing patterns for consistency
- Start by making the smallest reasonable changes

## docs.json

- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation

## 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
- Match style and formatting of existing pages
- Include both basic and advanced use cases
- Language tags on all code blocks
- Alt text on all images
- 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
- Commit frequently throughout development
- 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

Once you have Claude Code set up, try these prompts to see how it can help with common documentation tasks. You can copy and paste these examples directly, or adapt them for your specific needs.

Turn rough drafts into proper Markdown pages with components and frontmatter.

Example prompt:

Convert this text into a properly formatted MDX page: [paste your text here]

Get suggestions to improve style, formatting, and component usage.

Example prompt:

Review the files in docs/ and suggest improvements for consistency and clarity

Keep documentation current when your product evolves.

Example prompt:

Our API now requires a version parameter. Update our docs to include version=2024-01 in all examples

Create multi-language examples with error handling.

Example prompt:

Create code examples for [your API endpoint] in JavaScript, Python, and cURL with error handling

Beyond manually prompting Claude Code, you can integrate it with your existing workflows.

Run Claude Code automatically when code changes to keep docs up to date. You can trigger documentation reviews on pull requests or update examples when APIs change.

Use separate Claude Code sessions for different tasks - one for writing new content and another for reviewing and quality assurance. This helps maintain consistency and catch issues that a single session might miss.

Share your refined CLAUDE.md file with your team to ensure consistent documentation standards across all contributors. Teams often develop project-specific prompts and workflows that become part of their documentation process.

Create reusable slash commands in .claude/commands/ for frequently used documentation tasks specific to your project or team.

• Write documentation with Codex
• Mintlify CLI command reference
• Guides