Install Development Dependencies¶

OpenClaw-env-manager itself requires Python 3.12+. For documentation work, install the extra docs dependencies:

python -m pip install -e .[docs]

If you also want tests and coverage locally:

python -m pip install -e .[dev,docs]

Build The Documentation¶

Run a strict docs build:

python -m mkdocs build --strict

The generated site is written to site/.

Run The Local Preview Server¶

python -m mkdocs serve

MkDocs starts a local preview server and rebuilds on file changes.

Use The Makefile Shortcuts¶

make install-docs
make docs-build
make docs-serve

What The Docs Include¶

• project overview and workflow notes
• operational concepts such as manifests, lockfiles, and generated artifacts
• security notes describing the secure-by-default baseline and operator-visible advisories
• API pages generated directly from the Python source tree with mkdocstrings

CI Integration¶

GitHub Actions builds and publishes the documentation site in CI together with coverage. On pushes to main, the published GitHub Pages site serves:

• the MkDocs site at the repository root
• the HTML coverage report under /coverage/

To make that deployment visible publicly, configure GitHub Pages to use GitHub Actions as the build and deployment source.