Contributing to the MvvmCross documentation is a valuable way to help improve the framework and assist other developers. Here's a step-by-step guide on how you can contribute:
1. Understand the Documentation Structure**
MvvmCross uses Jekyll for its documentation, which means each page requires a YAML front matter. This includes specifying the layout, title, and category for the page. The layout is typically set to "documentation" unless you're editing a blog post. Categories should be reused and named consistently with existing ones in the menu[2].2. Familiarize Yourself with Markdown**
The documentation uses the same Markdown syntax as GitHub. You can refer to GitHub's Markdown reference for formatting guidelines. This includes how to add relative links and images to your documentation pages[2].3. Setting Up Jekyll Locally**
For larger changes, it's beneficial to set up the MvvmCross GitHub Pages site locally with Jekyll. This allows you to preview your changes before submitting them. You'll need to install Jekyll and follow GitHub's instructions for setting up a GitHub Pages site locally[2].4. Contribution Guidelines**
- Titles and Sentences: Keep them short and concise. Titles should ideally be three or four words long.- Chronological Order: Describe topics in a logical sequence.
- Stay on Topic: Avoid straying from the main subject.
- Grammar and Punctuation: Ensure proper use of grammar and punctuation.
- Spelling Checker: Use a spelling checker to minimize errors[2].
5. Submit Your Contributions**
Contributions are typically made through GitHub Pull Requests. You can edit existing pages or create new ones. If you're unsure about how to proceed, you can start by suggesting changes or discussing them with the team via GitHub issues or other support channels[1][5].6. Engage with the Community**
Besides contributing documentation, you can also help by sharing your experiences with MvvmCross, filing bugs, or participating in discussions. This feedback is invaluable for improving the framework[1].7. Review Process**
Your contributions will be reviewed to ensure they align with the documentation style and quality standards. This process helps maintain consistency across the documentation[2].By following these steps, you can effectively contribute to the MvvmCross documentation and help enhance the community's understanding and use of the framework.
Citations:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/MvvmCross/MvvmCross/blob/develop/CONTRIBUTING.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-App-and-Setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/Mapsui/Mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/MvvmCross/MvvmCross