Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 1.65 KB

Welcome to the AtlasOS documentation contributing guide

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.

How to use Markdown and MkDocs

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.

Issues

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.

More help?

You can use GitHub Docs Contributing Guidelines as a reference material. You can also ask in our Discord server for more help.