Octoform documentation

Source for the professional, versioned documentation of Octoform, a declarative plan/apply governance tool for GitHub repositories.

The published site is available at https://hector-ae21.github.io/octoform-docs/. Documentation is versioned by complete MAJOR.MINOR.PATCH. Documentation and Octoform share MAJOR.MINOR, while their patch numbers advance independently. Every version identifies the exact application patch it describes.

Local development

Prerequisites:

• Python 3.13
• Node.js 24
• Docker, for the digest-pinned PlantUML renderer

python -m venv .venv
.venv/bin/python -m pip install --require-hashes -r requirements.lock
npm ci
npm run render:diagrams
.venv/bin/mkdocs serve

On Windows PowerShell, replace .venv/bin/ with .venv/Scripts/.

The Node toolchain installs the exact documented Octoform release and validates every published configuration example against its real parser. Run every deterministic check with:

npm run verify

See CONTRIBUTING.md for content requirements, versioning, security boundaries, and the pull-request workflow.

Every revision merged into the default v0.x branch passes the complete verification suite, receives the next immutable editorial publication tag and GitHub Release, and updates the Pages path named after the exact Octoform version it documents. The matching MAJOR.MINOR, latest, and stable aliases move only after the pushed Pages tree matches the generated site.

Privacy

The site has no analytics, advertising, cookie banner, remote font request, or third-party diagram renderer. Fonts use the reader's system stack and PlantUML diagrams are rendered locally to static SVG during verification.

Licence

Documentation source and supporting code are available under the MIT License.