Tools Docs module

This module owns a distinct part of the HSLG implementation.

Canonical documentation pipeline

build_docs.py discovers owned source files and combines reviewed human prose with file-level references. It renders WordPress-safe HTML and records page/source hashes in a manifest and a bundle. check_docs.py validates those outputs and required hierarchy; package_docs_publisher.py checks release prerequisites and writes the independently installable WordPress ZIP.

Why this pipeline exists

Documentation is a release artifact as important as code. It must describe behaviour rather than merely enumerate files. Content is maintained in source Markdown so WordPress can be reconstructed after failure; existing HSLG-owned WordPress pages are revised using stable IDs. New sections need meaningful explanation, relevant source links and change/recovery implications, not copied template text.

Verification

Regenerate pages before testing. Reject stale hashes, missing substantive guides, collisions and short placeholder pages. Test the publisher independently so a documentation-only release is possible while a genuine Android build remains blocked. Local checks are not proof that the pages were published successfully on staging.

Source files in this module

• tools/docs/build_docs.py
• tools/docs/check_docs.py
• tools/docs/check_quality.py
• tools/docs/file_explanations.py
• tools/docs/module_explanations.py
• tools/docs/package_docs_publisher.py

Maintenance and evidence

Check all affected file references and the matching human-readable user/architecture page when source changes. Run the module’s contract or governance checks; staging, payment and native hardware tests remain independent of source inventory coverage.