CONTRIBUTING.md

Contributing to install.md

Thank you for your interest in contributing to the install.md specification!

Quick Links

• Full contribution guide
• Issues

Ways to Contribute

Share Examples

Have you created an install.md file for your project? Add it to our examples page!

Improve Documentation

• Fix typos or unclear explanations
• Add missing examples or use cases
• Improve the format specification

Build Integrations

Create tools that support install.md:

• CLI tools for executing install.md files
• IDE extensions
• Browser extensions
• Package manager integrations

Getting Started

1. Fork the repository
2. Clone your fork: git clone https://github.com/YOUR-USERNAME/install-md.git
3. Install Mintlify CLI: npm i -g mint
4. Start dev server: mint dev
5. Make your changes
6. Submit a pull request

Development

Documentation files are in .mdx format:

• index.mdx - Home page
• quickstart.mdx - Quick start guide
• essentials/format.mdx - Format specification
• essentials/examples.mdx - Example install.md files
• essentials/contributing.mdx - Full contribution guide

Community Standards

• Be respectful and considerate
• Welcome newcomers
• Give constructive feedback
• Focus on what's best for the project

Questions?

• Issues for bugs and feature requests

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.