Task: Overhaul ores.compass component overview
This page documents a task in the Tooling documentation story. It captures the goal, current status, acceptance, and any notes or results.
Goal
Extend ores.compass component overview
(projects/ores.compass/modeling/component_overview.org) with a
dedicated section for each command pillar:
| Pillar | Commands |
|---|---|
| Locate | where, status |
| Search | find / search, index |
| Navigate | list, show |
| Scaffold | add |
| Fleet | fleet |
| Goto | goto |
| Backlog | inbox, next, deferred, discarded |
Each section should contain:
- A paragraph describing the pillar's purpose and behaviour.
- Key command forms and flags (as a small table or code block).
- A table of related recipes linking via
[[id:UUID][Title]].
The existing Summary/Capabilities/Inputs/Outputs/Dependencies/Structure
sections are preserved; the new pillar sections are appended as a new
* Commands heading before * Dependencies.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Tooling documentation |
| Now | Complete. |
| Waiting on | — |
| Next | — |
| Last touched | 2026-05-29 |
Acceptance
projects/ores.compass/modeling/component_overview.orghas a new* Commandsheading before* Dependencies.- The
* Commandssection contains subsections for each command pillar (Locate, Search, Navigate, Scaffold, Fleet, Goto, Backlog). - Each pillar subsection contains a purpose paragraph, key command forms/flags, and a table of related recipes.
Plan
(Transient implementation strategy. Written when work starts;
distilled into the parent story's * Decisions and cleared when the
task closes. Plans do not outlive their task.)
Notes
PRs
| PR | Title |
|---|---|
| #909 | [doc] Add Commands section to ores.compass component overview |
Review
| # | Comment summary | File | Decision | Notes |
|---|---|---|---|---|
| 1 | "v2 documents" branding in Scaffold pillar | component_overview.org | Accept | Fixed in 2c3498e44 |
| 2 | Navigate missing recipe table | component_overview.org | Decline | No Navigate recipes exist yet; omit is correct. |
| 3 | Backlog missing recipe table | component_overview.org | Decline | Same — no Backlog recipes exist yet. |