Handbook

LCDL documentation remediation — master report

Fill this after each remediation wave. Do not paste secrets or raw tokens.

Updated

Maintainer reference — internal contributor documentation.

LCDL documentation remediation — master report

Fill this after each remediation wave. Do not paste secrets or raw tokens.

Repos and branches

Repo Branch git rev-parse HEAD
forge-lcdl (record branch) a4c12512e184e0dc9802d0c1ff7a1735cfe57034
forge-lcdl-website (record branch) fab077674e33e603601c2496806ee1430024f80b
Submodule forge-lcdl-website/forge-lcdl (record branch) bb64e1f63a1c89924badc1c13479645d61403fe9

Bump the forge-lcdl submodule pointer in forge-lcdl-website after forge-lcdl commits land so Hosting builds match canonical docs SHAs.

Wave — Composer packs 00–11 (2026-05-17)

  1. forge-autodoc: handbook_sidebar_flat_threshold on HandbookBuildConfig threaded through simple_build → build_sidebar_links; LCDL sets 0 for hierarchical scoped sidebar trees.
  2. LCDL chrome: PRIMARY_NAV_GROUPS drives desktop dropdowns + mobile offcanvas deep links; Reference adds Runtime boundary; Enterprise highlights API compatibility.
  3. SEO: seo_public_origin, seo_site_name, seo_default_og_image in generator/build-site.py plus robots.txt / sitemap.xml emitted each build.
  4. Docs: README handbook-first migration; stronger reference / enterprise cross-links; publishing notes for crawl assets.

Commands executed

Local forge-lcdl-website gates:

  • python3 generator/build-site.py --link-check → PASS (226 pages).
  • python3 scripts/check-generated-site.py --strict-diagrams --verify-rendered-diagrams → PASS.

Full forge-lcdl checklist (Handbook go / no-go checklist) — audit_docs_site.py --strict, audit_contract_docs.py, pytest — required before release tagging.

Live site evidence

  • URL: https://lcdl.forgesdlc.com/
  • Method: run from forge-lcdl-website: python3 scripts/inspect_handbook_html.py --url https://lcdl.forgesdlc.com/ or inspect local website/index.html with python3 scripts/inspect_handbook_html.py.
  • Notes: redeploy Firebase Hosting after submodule bump so CDN matches promoted commits.

Navigation / IA proof

Generated handbook HTML shows forge-lcdl-topnav dropdown IA, mirrored mobile accordion links, scoped sidebar rails without raw contract slugs on home, and diagram QA gates satisfied via check-generated-site.py.

Go / no-go

GO for generator + static QA on workspace SHAs — conditional on completing forge-lcdl audit/pytest gates and successful Hosting smoke before declaring production-ready parity.