Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

Documentation changes

This PR adds a guide on using Claude Code to maintain your docs. It includes a sample CLAUDE.md file, prompts for people to quickly get value from Claude Code, and ideas to inspire people to integrate it more deeply into their docs workflows without just reproducing Anthropic's docs.

Closes https://linear.app/mintlify/issue/DOC-90/add-claudemd-example


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

@ethanpalm ethanpalm merged commit 614e25f into main Jul 8, 2025
4 checks passed
@ethanpalm ethanpalm deleted the claude-code-docs branch July 8, 2025 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants