Documenting¶

User and developer guide¶

The user and developer guides are located in the docs/ directory of Goblint repository and written in Markdown. They can be browsed both on Read the Docs and GitHub directly.

Previewing Read the Docs locally¶

1. Install mkdocs: pip install mkdocs.
2. Run in the root directory of Goblint repository: mkdocs serve.
3. Open in the browser: http://127.0.0.1:8010.