Task: Review and link ores.lisp and ores.codegen overviews
This page documents a task in the Tooling documentation story. It captures the goal, current status, acceptance, and any notes or results.
Goal
Review ores.lisp and ores.codegen component overviews and ensure they
are complete, accurate, and reachable from the new * Tooling section
in Knowledge.
For each component:
- Read the existing overview and check for gaps against the source (missing commands, outdated entry points, absent recipe links).
- Fill any gaps in-place — no structural rewrites unless the content is fundamentally wrong.
- Confirm the component is linked from
knowledge.org* Tooling(T1 adds those links; this task verifies and plugs any that T1 missed).
Additionally: check whether any other developer tool in the repo
(e.g. build/scripts/, any project-level scripts not covered by T1
or T3) should be catalogued. If found, add them to the developer
scripts doc or raise a capture.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Tooling documentation |
| Now | Nothing. |
| Waiting on | — |
| Next | — |
| Last touched | 2026-05-29 |
Acceptance
ores.lispandores.codegencomponent overviews are reviewed and updated for completeness.- Both overviews are verified to be linked from the
* Toolingsection inknowledge.org. - Any additional developer tools or project-level scripts are catalogued or captured.
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 |
|---|---|
| #913 | [doc] Review ores.lisp and ores.codegen component overviews |
Review
| # | Comment summary | File | Decision | Notes |
|---|---|---|---|---|
| 1 | DONE task's Now field should be Nothing. not descriptive prose. |
task_add_ores_sql_scripts_section.org | Accept | Fixed in c980b6e7b. |
| 2 | Empty PRs/Review tables should be omitted from new task docs. | task_standardise_script_naming.org | Decline | Standard template convention — all task docs start with these sections. |