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.

Getting started

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.

CLAUDE.md template

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

Sample prompts

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.

Convert notes to polished docs

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]

Review docs for consistency

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

Example prompt:

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

Update docs when features change

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

Generate comprehensive code 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

Extend Claude Code

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

Automate with GitHub Actions

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 API changes are detected.

Multi-instance workflows

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.

Team collaboration

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.

Custom commands

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

Frequently asked questions

Do I need a CLAUDE.md file to use Claude Code with Mintlify?

No, but it significantly improves output quality. Without a CLAUDE.md, Claude Code works from general context and may not follow your specific style guide, component preferences, or terminology. A CLAUDE.md file trains Claude Code on your project’s standards so you don’t need to re-explain them in every prompt.

How is Claude Code different from Cursor or Windsurf for documentation?

Claude Code is a command-line tool designed for agentic, multi-step tasks across an entire repository. It’s well-suited for tasks like auditing all pages for missing alt text, updating a parameter name across every code example, or reviewing a set of files for consistency. Cursor and Windsurf are IDE-based tools better suited for editing individual files with inline suggestions. Both approaches work—the right choice depends on whether your work is file-by-file or across the whole repo.

Can I use Claude Code to generate documentation from code automatically?

Yes. Claude Code can read your source code and generate corresponding documentation. Point it at an API endpoint, a configuration file, or a set of functions and ask it to produce matching documentation following your CLAUDE.md standards. Review and refine the output—automated generation works best when you treat Claude Code as a first draft author, not a final publisher.

How do I share my CLAUDE.md configuration with my team?

Commit the CLAUDE.md file to your documentation repository. Anyone who clones the repo and runs Claude Code will automatically use your project’s configuration. This makes documentation standards consistent across contributors without requiring each person to set up their own context.