Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1.62 KB

Contributing to MCP Documentation

Thank you for your interest in contributing to the Model Context Protocol (MCP) documentation! This guide will help you get started with contributing.

Getting Started

  1. Install the required tools:
  2. Fork and clone the repository
  3. Create a new branch for your changes
  4. Run mintlify dev to preview changes locally

Documentation Guidelines

  • Keep content clear, concise, and technically accurate
  • Follow the existing file structure and naming conventions
  • Include code examples where appropriate
  • Use proper MDX formatting and components
  • Test all links and code samples

Content Types

You can contribute to:

  • Conceptual guides
  • API reference documentation
  • Tutorials and quickstarts
  • Best practices and examples
  • Troubleshooting guides

Pull Request Process

  1. Ensure your changes follow our documentation guidelines
  2. Update the relevant table of contents if needed
  3. Test your changes locally using mintlify dev
  4. Submit a pull request with a clear description of your changes
  5. Wait for review and address any feedback

Need Help?

Code of Conduct

Please note that this project follows our Code of Conduct. By participating, you agree to uphold these guidelines.