How this reference stays accurate

The documentation combines authored user guides, authenticated screenshots, and generated references tied to the source. Each has a different maintenance path.

Update the guides

When a workflow changes, update the steps and capture the actual interface again. Keep the distinction between Helm chat, direct workspace controls, the terminal, the platform API, and the instance API. Explain the user outcome before implementation terminology.

Screenshots should show real UI state. Do not substitute a design mockup for a successful product journey or include credentials in an image.

Regenerate references

From the Akasha repository root, regenerate the instance contract with:

python3 minds-docs/scripts/generate-instance-reference.py
python3 minds-docs/scripts/generate-instance-reference.py --check

The generator accounts for route registration, handlers, typed request fields, response assembly, and source locations. Dynamic or unresolved wire types are flagged; they are not guessed into a strict schema.

The platform and developer inventories have separate generators:

node minds-docs/scripts/generate-platform-reference.mjs
node minds-docs/scripts/generate-sdk-inventory.mjs
node minds-docs/scripts/generate-platform-reference.mjs --check
node minds-docs/scripts/generate-sdk-inventory.mjs --check

All three generators maintain manifests of the files they own. Checks do not write; generation removes obsolete owned pages while refusing to delete a stale file edited by hand. Regenerate after changing an API, parser declaration, or SDK surface.

Keep verification explicit

A reference update should state the source revision, local validation, deployed revision when applicable, and the user journey actually tested. Backend fixes need a fresh runtime check before removing a compatibility note. Every repository change also requires the local and ecosystem changelog updates.