Problem
CodingScaffold uses domain terms that are scattered across wiki pages and not defined in one place: scaffold artifact, adapter, routing, skill, memory, MCP, persona, orchestration, weak/strong model, agentic change, eval, session trace, policy pack. A new user has to read several wiki pages to translate the CLI output.
Why it matters
This is the cheapest possible win for new-dev usefulness. The terms are not optional — they appear in --help, in doctor output, and in every generated template. A glossary turns the docs from "reference for someone who already knows" into "reference you can read cold".
Proposed approach
- Add
docs/docs/wiki/Glossary.md with one paragraph per term, alphabetical, link to the wiki page that goes deeper.
- Link the glossary from:
- Add a
docs/docs/wiki/_glossary_terms.json or similar machine-readable list, and a small test that asserts every term used in --help or printed by the CLI appears in the glossary.
Acceptance criteria
Glossary.md exists with at least the terms listed above.
- Linked from
index.md and from CLI --help footer.
- CI test fails if a new term shows up in
cli.py help strings without a glossary entry.
Problem
CodingScaffold uses domain terms that are scattered across wiki pages and not defined in one place: scaffold artifact, adapter, routing, skill, memory, MCP, persona, orchestration, weak/strong model, agentic change, eval, session trace, policy pack. A new user has to read several wiki pages to translate the CLI output.
Why it matters
This is the cheapest possible win for new-dev usefulness. The terms are not optional — they appear in
--help, indoctoroutput, and in every generated template. A glossary turns the docs from "reference for someone who already knows" into "reference you can read cold".Proposed approach
docs/docs/wiki/Glossary.mdwith one paragraph per term, alphabetical, link to the wiki page that goes deeper.index.mdcoding-scaffold --help("Terms: see https://jrs1986.github.io/CodingScaffold/wiki/Glossary\")doctoroutputdocs/docs/wiki/_glossary_terms.jsonor similar machine-readable list, and a small test that asserts every term used in--helpor printed by the CLI appears in the glossary.Acceptance criteria
Glossary.mdexists with at least the terms listed above.index.mdand from CLI--helpfooter.cli.pyhelp strings without a glossary entry.