Story: Entity manual: add shell documentation per chapter
Table of Contents
This page documents a story in Sprint 19. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
Goal
Every entity chapter in the user manual covers both the Qt desktop UI and the shell (REPL) commands side by side, giving users a complete, single-source reference for each entity regardless of which access layer they prefer.
Status
| Field | Value |
|---|---|
| State | BACKLOG |
| Parent sprint | Sprint 19 |
| Now | Not yet started. |
| Waiting on | Nothing. |
| Next | Break the story into tasks. |
| Last touched | 2026-05-29 |
Acceptance
- Each entity chapter (that has shell support) has a "Shell" subsection with REPL command examples.
- Shell command examples are verified against the running system.
- Chapters are written hand-in-hand with the ores.refdata Commissioning stories' verification pass.
- Site builds cleanly with no broken links.
See also
- Sprint 19 — ores.refdata Commissioning epic stories are worked in parallel with documentation.
- Entity Coverage Matrix — identifies which entities have shell support.