This directory holds the source for the in-app MIDAS User Guide served
at /help/. It is the user-facing help surface for the application
experience — distinct from docs/, which holds engineering / design /
operational documentation.
userguide/
mkdocs.yml # Material for MkDocs config
src/
index.md # /help/
explorer/ # /help/explorer/
graphs/ # /help/graphs/
governance/ # /help/governance/
evidence/ # /help/evidence/
operations/ # /help/operations/
assets/screenshots/ # placeholder dirs; commit PNGs here later
Generated output goes to internal/httpapi/help/static/, which is
committed and embedded into the MIDAS binary via //go:embed help/static
in internal/httpapi/help.go.
make help-build
The target shells out to docker run squidfunk/mkdocs-material:latest build so no Python or MkDocs install is required on the host.
To wipe generated output:
make help-clean
- Create
userguide/src/<area>/<page>.md(kebab-case filename). - Add the page to
nav:inuserguide/mkdocs.yml. - Add anchor IDs only when the heading slug would otherwise drift. Use
## Heading {#explicit-anchor}—attr_listis enabled. make help-buildto regenerate.- If the new page is a likely target for context-help, add a mapping in
internal/httpapi/explorer/assets/js/help/help-links.js.
-
Drop the PNG under
userguide/src/assets/screenshots/<area>/<name>.png. -
Reference it from Markdown with a relative path:
 -
make help-build.
Help button context resolution lives in
internal/httpapi/explorer/assets/js/help/help-context.js. The mapping
keys are in help-links.js. Add the new key + URL to the CONTEXT_MAP
and (if needed) extend the resolver to surface it.
Keep URLs in the canonical shape /help/<area>/<page>/[#anchor]. Do not
introduce /help/help/<page>/ shapes — the route is mounted at /help/
so the source files live directly under userguide/src/, never under
userguide/src/help/.
- MkDocs is build-time only. The runtime image (
Dockerfile) is the same single Go binary — no Python, no MkDocs, no second container. - MIDAS remains a single application/container. No second runtime process, no second port, no proxy.
- React and Docusaurus are intentionally not introduced for this tranche. The User Guide is plain Markdown compiled by MkDocs into static HTML.