Read here first: https://docs.atlasos.net/contributions
Thank you for being invested in helping out AtlasOS and our documentation. This is amazingly useful to us and we appreciate it a lot!
Read our Code of Conduct to keep our community approachable and respectable.
We use Markdown for our documentation. If you are new to Markdown, we recommend reading the Markdown Guide to get started.
We also use MkDocs to build our documentation. If you are new to MkDocs, we recommend reading the MkDocs documentation to get started.
The theme we use for MkDocs is Material for MkDocs. If you are new to Material for MkDocs, we recommend reading the Material for MkDocs documentation to get started. You can find lots of useful information on styling, and how to use MkDocs to your best.
We use the Insiders edition of Material for MkDocs, so do not worry about formatting or feature limitations when creating documentation. Keep in mind that you'll need your own copy of Material for MkDocs Insiders to build and preview the documentation locally with the right formatting and features support. Alternatively, you can temporarily comment out all of the insider only features in the MkDocs configuration.
If you find any issues with our documentation, please open an issue. Please fill issues out with utmost detail and preferably images too so we can understand where we went wrong or so contributors can make a pull request to fix the issue.
You can follow the GitHub docs contributing guide for more help. You can also ask in our Discord server for more help as well.