Skip to content

Contributing to the Atlas documentation

This page will cover how to modify and locally view the Atlas documentation. This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the Contribution Guidelines first!

Our contribution platform

Atlas uses GitHub to manage everything. Please note that our documentation does not contain instructions on how to use GitHub or Git; if you're unfamiliar with them, see the GitHub quick-start guide 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

Tip

We recommend viewing their reference documentation.

Prerequisites

As MkDocs Material uses Python, you must install Python, including pip. Additionally, 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.

  1. Run locally-host.cmd to host the documentation preview
    • This also installs and updates dependencies
  2. Navigate to the URL it provides in the console
  1. Run pip install -r local-requirements.txt to install all the dependencies inside of the repository
    • You might need to use a virtual environment or distro-specific packages for dependencies
    • Consider checking the VSCode extension recommendations
  2. Run mkdocs serve to host the documentation preview
  3. Navigate to the URL it provides in the console