Handbook
Enterprise operations
Publishing is a sibling repo (forge-lcdl-website) — see Website publishing.
Updated
Recommended offline gate
python -m compileall -q src tests scripts examples
pytest -q
python3 scripts/audit_contract_docs.py --strict --strict-md
python3 scripts/audit_docs_site.py
CI quality gate chain (summary)
| Step | Command | Purpose |
|---|---|---|
| 1 | python -m compileall -q … |
Catch syntax errors early. |
| 2 | pytest -q |
Unit and smoke tests. |
| 3–4 | audit_contract_docs.py --strict --strict-md |
Sidecars + all contract Markdown heuristic. |
| 5 | audit_docs_site.py |
Internal .md link resolution in docs/. |
| 6 | (optional) forge-lcdl-website build-site.py --link-check |
Full handbook link check in static build. |
CI quality gate chain
The bounded offline checks operators run before merging or publishing LCDL changes.
- compileallCatches Python syntax errors across src, tests, scripts, and examples.
- pytestRuns unit and smoke tests for reviewable regression coverage.
- audit_contract_docs --strictVerifies contract sidecars and Markdown heuristic compliance.
- audit_docs_siteResolves internal Markdown links across the docs tree.
- (optional) build-site.py --link-checkOptionally validates handbook links in the static site build.
compileall
|
v
pytest
|
v
audit_contract_docs --strict
|
v
audit_docs_site
|
v
(optional) build-site.py --link-checkBenchmarks
- Default fake transport — see Benchmarks.
- Optional
--liveonly in controlled environments with credentials.
Handbook site
Publishing is a sibling repo (forge-lcdl-website) — see Website publishing.