The documentation is written in GitHub flavored Markdown. It is located in the doc/ directory and can be edited with your preferred editor. You can also edit it online on GitHub.

vim doc/2-getting-started.md

In order to review and test changes, you can install the mkdocs Python library.

pip install mkdocs

This allows you to start a local mkdocs viewer instance on http://localhost:8000

mkdocs serve

Changes on the chapter layout can be done inside the mkdocs.yml file in the main tree.

There also is a script to ensure that relative URLs to other sections are updated. This script also checks for broken URLs.

./doc/update-links.py doc/*.md

//todo: use https://github.com/Icinga/icinga-docs-tools