Update MCP Docs with Mintlify guidelines

[ericallam]

This commit introduces a new documentation file, CLAUDE.md, outlining the standards and practices using Mintlify for our documentation. The update was needed to provide comprehensive guidelines for creating and maintaining consistent, high-quality documentation that supports user success while aligning with our project context.

• Implement a framework for collaborative documentation efforts, encouraging constructive feedback and evidence-based reasoning.
• Emphasize the importance of accuracy, usability, and making content evergreen.
• Highlight writing standards such as using second-person voice, testing code examples, and maintaining consistent style and formatting.
• Include a strict Git workflow, advocating for frequent commits and adherence to pre-commit hooks.

The new CLAUDE.md file serves as a foundation for future documentation efforts, ensuring clarity and effectiveness in how we convey information to users.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: d166ba1bd948c30af575e458a0533897d68e7c60

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai[bot]]

Walkthrough

A new documentation file docs/CLAUDE.md was added. It provides MD/MDX Mintlify documentation guidelines, including use of Mintlify components, frontmatter requirements (title, description), writing standards (voice, prerequisites, testing, consistency, evergreen content, code block language tags, image alt text, relative links), references to docs.json schema, and a Git workflow (branching, commits, pre-commit hooks). It also lists explicit “do-not” guidelines (no omitted frontmatter in MDX, no absolute internal links, no untested code, no assumptions). No code, interfaces, or exports were changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment
• [ ] Commit unit tests in branch improve-docs-with-mintlify-standards

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.