Task: Write currency documentation (manual chapter, recipes, NATS reference)
This page documents a task in the Commission: currency story. It captures the goal, current status, acceptance, and any notes or results.
Goal
Produce all missing documentation for the currency entity:
- Manual chapter (
doc/manual/user_guide/) — what currencies are, Qt MDI list window, detail dialog (fields and validation), history dialog, delete, shell commands, CLI commands. - CLI recipe (
doc/recipes/cli/) — update or create the currency CLI recipe to reflect post-NATS commands. - Shell recipe (
doc/recipes/shell/) — create a shell recipe covering the interactive currency submenu commands. - NATS message reference — document the NATS subjects and message types used by the currency entity (request/reply and event subjects), either as a dedicated recipe file or a section in the manual chapter.
The manual chapter is the highest-priority item; it is entirely absent.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Commission: currency |
| Now | Nothing. |
| Waiting on | Nothing. |
| Next | Nothing. |
| Last touched | 2026-05-29 |
Acceptance
- Manual chapter exists in
doc/manual/user_guide/and covers: entity description, Qt list window, detail dialog (all fields), history dialog, delete, shell commands, CLI commands. - CLI recipe created or updated in
doc/recipes/cli/; reflects post-NATS usage. - Shell recipe created in
doc/recipes/; covers list, add, remove, history commands. - NATS message reference documents: request subjects (list, count, get, save, delete, history), event subjects (saved, deleted), and the message type for each.
- Manual chapter referenced from the manual index.
- Site builds cleanly.
PRs
Review
| # | Comment summary | File | Decision | Notes |
|---|---|---|---|---|
| 1 | Chapter 4 missing required '** Overview' section | doc/manual/user_guide/chapter_4_reference_data.org | Accepted | Fixed in e41e24392; heading added before intro paragraph. |
| 2 | Internal manual cross-reference uses file: link instead of id: link | doc/manual/user_guide/chapter_5_currencies.org | Accepted | Fixed in 3478b213a; now links to chapter 4 id FD54D29E. |
| 3 | Use full path for currency_history_protocol.hpp | ores.refdata.protocol.org | Accepted | Fixed in 9ec9a0326. |
| 3 | Capture has template placeholders | task_start_crashes capture | Accepted | Fixed in 9ec9a0326; idea and context filled. |
Result
All four documentation artefacts delivered: manual chapter 5 (currencies end to end, wired into user_manual.org; PDF builds clean), six CLI recipes (verified post-NATS by the verify-cli task), shell recipes for the currencies submenu (add/get/delete/list/ history/history-diff/help — add.org corrected to the seven-argument form with a real captured success run, replacing the old constraint-violation failure), and the NATS message reference enriched with per-subject request/response types and the currency_changed event. Legacy generate_protocol_docs.py deleted.