Contributing to the Atlas documentation

This page will cover how to modify and locally view the Atlas documentation. We highly recommend reading through the Contribution Guidelines first!

We presume you've already cloned the Atlas-OS/docs repository.

How the documentation is built

MkDocs Material is used to build the Atlas docs, which uses the following:

• YAML configuration
• HTML, JavaScript, and CSS overrides
• Extended Markdown for the pages

We recommend viewing their reference documentation.

Installing dependencies

1. As MkDocs Material uses Python, you must install Python alongside pip
2. Run pip install -r local-requirements.txt to install all the dependencies inside of the repository
   • You might need to use a virtual environment on Linux or distro-specific packages for dependencies
   • Consider checking the VSCode extension recommendations

Viewing your changes live

The docs will refresh on any page change and reflect what you've just saved.