Contributions are welcome and encouraged.
Meshtastic is built on people collaborating and working together and we strive to continue that in this wiki.
Please fully read the contributing guide before contributing, failure to do so can have your pull request denied and you can be banned from contributing.
We take our community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
We have a zero tolerance for any demeaning/derogatory/hurtful wording in the wiki or towards anyone else. If you participate in this behaviour you will be banned.
Please adhere to the following guidelines when writing documentation. As long as you don't go against the code of conduct no actions will be taken against you. However, you will be asked to make some changes to your pull request before it will be accepted.
- Make sure your writing is polite and respectful
- Please keep language gender neutral
- If you link to any external resources make sure they aline with our code of conduct
- Do not add any links that include affiliate commissions
This wiki is built with Doctave. It is highly recommended that you install Doctave so you can preview pages.
Once you have Doctave make a fork of the repo and clone your fork do your computer.
Now that you have a copy of the repository on your computer you can open it in your favourite text editor. For information on formatting and features please review the Doctave documentation.
To preview changes use the below command to build website localy, the website will autoreload when you save a file.
$ doctave serve
When you are happy with your changes you will need to add, commit and push your changes to your repo, then create a pull request for a community manager to approve.
Once approved and merged into the main repo the website will automatically be updated with the changes.
When contributing to the recommendations part of the wiki you will need to copy correct device template from the templates folder. Once copied to the correct page fill out all the details.
When adding a testimonial to a page you will need to link it to your github account page.
If you want to remove a testimonial you have provide please make an issue or remove the testimonial and make a pull request.
Caution
We will only remove the testimonials on request of the testimonial holder. If you make an issue or pull request against a testimonial that is not your own it will be denied. Repeated attempts will be meet with repercussions.