Gettings Started

Normal setup

1. Install mkdocs
2. Install the python packages listed in core/apps/docs/requirements.txt
3. Run:

mkdocs serve

Warning

If the site does not generate because there is still missing dependancies, you can find them using mkdocs-get-deps

For linux distributions which do not package python packages through pip

This includes Arch Linux.

1. Run

   python -m venv env
   source env/bin/activate
   

2. Install packages

   pip install -r requirements.txt
   

3. Run with

   mkdocs serve
   

---

Now just make normal changes to the documentation and the site will update automatically. Make commits and push your changes when you're done!