Documentation Operations
OPERATIONS / TECHNICAL

Documentation that follows code

How release checks keep all three reading versions aligned with implementation.

Source matching

Each code repository exposes a deterministic fingerprint of its implementation and workflow files. The wiki stores those fingerprints in sources.lock.json. The deployment gate computes the candidate fingerprint and compares it with the validated wiki revision.

Authoring workflow

Update the affected topic in all three modes, update factual inventories, and refresh the source lock. Validate all topics and build the static site. Merge the documentation revision before the matching runtime release proceeds.

Release evidence

The deployment manifest records the code and documentation SHAs. Daily checks detect missing synchronization events. A mismatch is reported as a failed gate rather than silently updating prose from code.

README role

Repository READMEs describe purpose and entry points. Detailed operational instructions remain here.

ON THIS PAGE

THREE WAYS TO UNDERSTAND

Same system.
Your level of detail.

Switch reading modes above to find the explanation that fits.

Explore Expert →

Keep exploring

Backups & recovery

Protect existing data and know which recovery path to use.

Add another application

Extend the portal without changing the production AI contract.