Start at docs/index.md, or read the pages in order:

Start

1. Install the software
2. Convert your first model

Converting

3. How a part is represented
4. Convert only part of a model
5. Give it materials
6. Field and cuts
7. The geom.C file

Simulating

8. Add passive geometry
9. Make it produce hits
10. Grow it into a real detector

Worked example

11. The ITS, out and back again

Reference

12. Check your geometry
13. Limits and pain points

Every page is plain Markdown and renders correctly in the GitHub file view: alerts use GitHub's own > [!NOTE] syntax, the diagrams are ```mermaid fences, and the figures are ordinary images in docs/images/. Nothing has to be published for someone to read this.

The same sources build a browsable site with search and a sidebar:

pip install mkdocs-material
mkdocs serve        # http://127.0.0.1:8000
mkdocs build        # static site in ./site

hooks/github_alerts.py turns the GitHub alerts into Material admonitions at build time, so the Markdown stays GitHub-native and no extra plugin is needed.