This repository hosts the English-translated .md files used to generate the static HTML documentation for the CMMV website. The goal is to provide clear and accessible documentation for the global community of developers using CMMV.
We welcome contributions to improve the quality, accuracy, and clarity of the documentation. To contribute:
-
Fork the Repository:
Start by forking this repository to your GitHub account. -
Make Your Edits:
Edit or create.mdfiles based on the structure and content standards already established in the documentation. -
Follow Best Practices:
Ensure your contributions follow the existing writing style and formatting conventions:- Use clear and concise language.
- Include code examples when applicable.
- Use proper Markdown syntax and structure.
-
Submit a Pull Request:
Once your changes are complete, open a pull request (PR) to propose your contributions. Please provide a clear description of the changes in the PR.
- Consistency: Maintain the same tone, structure, and formatting style as the existing documentation.
- Clarity: Ensure that technical terms and concepts are explained clearly.
- Examples: Provide practical code snippets where applicable.
- Accuracy: Verify that all information is up-to-date and aligns with the current CMMV version.
The .md files in this repository are converted into static HTML pages for the CMMV documentation site. Changes submitted here will reflect directly on the website after review and deployment.
Thank you for contributing to the CMMV documentation and helping developers worldwide understand and adopt this powerful framework!