Published with MkDocs Material from this tree. Live site: https://theworker02.github.io/shiftlock/.
From the repository root (Python 3.10+):
pip install -r requirements-docs.txt
mkdocs serve -f docs/site/mkdocs.ymlBuild:
mkdocs build --strict -f docs/site/mkdocs.ymlSite dependencies stay in requirements-docs.txt — never in go.mod.
| Section | Path |
|---|---|
| Introduction | introduction/ |
| Quick Start | quick-start/ |
| Concepts | concepts/ |
| Ownership | ownership/ |
| Fencing | fencing/ |
| Handoffs | handoffs/ |
| Supervisor | supervisor/ |
| Leader Election | leader-election/ |
| Scheduling | scheduling/ |
| Barriers | barriers/ |
| Quorum | quorum/ |
| Capabilities | capabilities/ |
| Security Policies | security-policies/ |
| Maintenance | maintenance/ |
| Lockdown | lockdown/ |
| Configuration | configuration/ |
| Audit | audit/ |
| Recovery | recovery/ |
| Backends | backends/ |
| Integrations | integrations/ |
| Kubernetes | kubernetes/ |
| systemd | systemd/ |
| Windows | windows/ |
| CLI | cli/ |
| TUI | tui/ |
| Operations | operations/ |
| Threat Model | threat-model/ |
| Security Hardening | security-hardening/ |
| Production Checklist | production-checklist/ |
| API Reference | api-reference/ |
| Examples | examples/ |
| Problem guides | problems/ |
GitHub Actions workflow .github/workflows/pages.yml
builds on pushes to main that touch docs/site (and related paths) and on
workflow_dispatch.
GitHub Pages source must be GitHub Actions (Settings → Pages → Build and deployment → Source: GitHub Actions).
Theme colors follow brand guidelines
(Lock Cyan #27C2D1, Transfer Blue #2D72E8, Deep Navy #0A1830). Logos under
assets/ are copies of assets/logo/ for MkDocs docs_dir constraints.
See also: