Maintaining the documentation

The short task pages are the main user path; detailed contracts live under Reference. CLI help, schema tables, presets and downloadable templates are generated by scripts/docs_reference.py. Edit templates under src/dwarl/templates/.

Regenerate the robot-neutral model illustration with MUJOCO_GL=egl pixi run python scripts/docs_examples.py. Add --test-directory with a testbot smoke-test directory to refresh the example trajectory.

The site is built from docs/ with MkDocs. Search and navigation expose the workflow; command help and resolved configuration are generated directly from the implementation at build time. Update the walkthrough when behavior changes.

Preview without installing the training stack (the slim docs pixi environment):

pixi run docs-serve      # mkdocs serve
pixi run docs            # mkdocs build --strict, as in CI

CI builds with mkdocs build --strict on every main push and pull request and uploads a downloadable documentation artifact. This catches broken internal links and keeps the generated reference in sync with code.

GitHub Pages

To host the site, enable Settings → Pages → GitHub Actions and set the repository Actions variable PAGES_ENABLED to true. Re-run Documentation or push to main. Subsequent main pushes automatically deploy the site at https://nobleo.github.io/dwarl/. Until then, use the CI artifact or local preview.