Task: Add Tooling section to knowledge.org and developer scripts doc
This page documents a task in the Tooling documentation story. It captures the goal, current status, acceptance, and any notes or results.
Goal
Add a * Tooling section to Knowledge (doc/knowledge/knowledge.org)
alongside the existing Domain and Architecture sections. Write a new
Developer scripts knowledge doc at
doc/knowledge/architecture/developer_scripts.org that:
- Catalogues every standalone script in
scripts/grouped by purpose (metrics/reporting, validation, CI support, agile tooling). - Provides a one-paragraph description per script and notes the corresponding Python script where a shell wrapper exists.
- Links to ores.sql and ores.compass for their respective script families.
The Tooling section in knowledge.org must also link to ores.compass,
ores.codegen, ores.lisp, and ores.sql component overviews directly.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Tooling documentation |
| Now | Complete. |
| Waiting on | — |
| Next | — |
| Last touched | 2026-05-29 |
Acceptance
doc/knowledge/knowledge.orgcontains a* Toolingsection linking to the developer scripts doc and the component overviews ofores.compass,ores.codegen,ores.lisp, andores.sql.- A new
Developer scriptsknowledge doc is created atdoc/knowledge/architecture/developer_scripts.org. - The developer scripts doc catalogues standalone scripts in
scripts/grouped by purpose with descriptions and links to respective component overviews.
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
Review
| # | Comment summary | File | Decision | Notes |
|---|---|---|---|---|
| 1 | Acceptance criteria section empty (all 4 tasks) | task_implement_tooling_documentation.org | Accept | Fixed in 8ef145efe |
| 2 | Inconsistent script naming (hyphens vs underscores) | developer_scripts.org | Decline | Doc reflects actual filenames; rename is a separate task. |