Skip to main content

Manual maintenance

This manual is part of the product. Treat it like code.

Required updates​

Update the manual when a change affects:

  • a route;
  • page name or navigation label;
  • visible copy;
  • button, form, table, filter, or workflow;
  • role or module access;
  • product state shown in screenshots;
  • partially implemented features.

Required checks​

Run these from the repository root unless a task explicitly says otherwise:

npm --prefix docs-site run coverage:check
npm --prefix docs-site run screenshots
npm --prefix docs-site run screenshots:check
npm --prefix docs-site run build

Screenshot generation expects the local e2e Angular app, API, and Keycloak devstack to be running. The docs workflow starts those services automatically for branch builds.

Long-running branches​

Other worktrees may land into dev while documentation work is still in progress. Before merging:

  1. Pull the latest dev.
  2. Re-run route coverage.
  3. Re-generate screenshots.
  4. Re-read visible UI changes that landed since this branch started.
  5. Update the manual and PARTIALLY_IMPLEMENTED_FEATURES.md before publishing.
caution

Do not merge a UI change that makes this manual false. If the product changes, the manual changes with it.