[dmccoystephenson]

Summary

• A Stage A documentation accuracy sweep was run against README.md and CONTRIBUTING.md.
• One gap was found: create, list, update, delete and export each have an examples section in the README, but view has only its one-line entry in the command list. Its output format, the score words, and the not-found message were undocumented.
• A View Examples section is added between List Examples and Update Examples, which follows the order of the command list. It shows the output for the project from the create examples (-i 4 -c 3 -e 5 -r 2 -f 3).
• Each claim was checked against source:
  • ViewProjectCommand.execute sets the line order and labels, uses %.2f for the ICE and RICE scores, and returns Project not found: <name> for an unknown name.
  • ScoreDescriptionProvider.getDescription maps 1-5 to very low/low/medium/high/very high, and any other value to its number. ViewProjectCommandTest.shouldShowRawNumberForScoreOutsideOneToFive also covers this.
  • ScoreCalculator gives ICE = 4×3×5 = 60.00 and RICE = (2×4×3)÷3 = 8.00.
• The rest of the sweep found no drift. The CI claims in CONTRIBUTING.md match .github/workflows/ci.yml and build.yml.

No tracking issue exists for this change. The gap was found during triage.

Deferred: #27 (controller endpoints) is still blocked for the reasons recorded on the issue. It needs a web dependency in build.gradle, which is on the do-not-auto-merge list, and the endpoint, port and bind-address decisions are still open.

Test plan

• Every line of the example output was traced through ViewProjectCommand, ScoreDescriptionProvider and ScoreCalculator
• CI (CI Pipeline, Build and Test) is green. The change is docs-only, so the local Gradle anchor is UNVERIFIED-not-applicable.

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code

---

drafted by Claude on behalf of Daniel Stephenson

[github-actions]

Test Results

178 tests  ±0   178 ✅ ±0   1s ⏱️ -1s
 24 suites ±0     0 💤 ±0 
 24 files   ±0     0 ❌ ±0 

Results for commit 0cdcd90. ± Comparison against base commit 79fe072.

[dmccoystephenson]

Self-review rubric:

• Scope: PASS — only README.md is modified, with one new View Examples section plus a follow-up wording fix. Nothing unrelated is touched.
• Tests-new: PASS (not applicable) — no code is added.
• Tests-fix: PASS (not applicable) — no bug fix is made. The PR adds documentation only.
• Sibling structure: PASS — the heading, bash block and prose paragraph follow the ### <Command> Examples sections next to it. The section sits between List and Update, which matches the order of the command list.
• Sibling renames: PASS (not applicable) — nothing is renamed.
• Docs: PASS — the README was checked against ViewProjectCommand (line labels and order, %.2f, not-found text), ScoreDescriptionProvider (1-5 words, other values shown as numbers) and ScoreCalculator (ICE 60.00, RICE 8.00). CONTRIBUTING.md was checked against both workflows, and no drift was found.
• Issue resolution: PASS (not applicable) — no Closes reference is made. The gap was found during triage.
• Manual validation: PASS — CI Pipeline / test and Build and Test / build (21) are green on the head commit. The Test Results bot reports 178 tests run, 178 passed and 0 failed, the same as on main.
• Shell command tests / round-trip coverage / I/O behind an interface: PASS (not applicable) — no code is changed.

Finding (fixed in the second commit):

• README.md:122 — "the project from the create examples above" was ambiguous. Three create invocations are shown there, and the output only fits the option-only one, so the sentence now names it by its scores.

Not changed: the example output omits the blank line that Spring Shell prints after the trailing \n. This is a cosmetic difference and was judged not worth documenting.

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

---

drafted by Claude on behalf of Daniel Stephenson