Skip to content

Correct README and CONTRIBUTING drift found in a docs sweep - #60

Merged
dmccoystephenson merged 2 commits into
mainfrom
feat/docs-accuracy-sweep
Oct 9, 2026
Merged

dmccoystephenson merged 2 commits into
mainfrom
feat/docs-accuracy-sweep

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

Stage A documentation accuracy sweep: every claim in README.md and CONTRIBUTING.md was checked against the source, build.gradle and the two workflows. Drift found and corrected:

  • Launch command did not reliably run. ./gradlew build writes both Parpt-<version>.jar (boot jar) and Parpt-<version>-plain.jar (no Main-Class in its manifest — confirmed by reading both manifests). The documented java -jar build/libs/Parpt-*.jar expands to both; in byte order the plain jar sorts first, so java gets the non-runnable jar and fails with no main manifest attribute. The Installation, Getting Started and Usage reporting commands now name Parpt-<version>.jar, and the two jars are explained.
  • Unfenced commands. The Installation and Getting Started commands were plain paragraph text, so GitHub rendered them as one run-on line; they are now fenced bash blocks.
  • create options undocumented. CreateProjectCommand accepts -n/-d/-i/-c/-e/-r/-f and only prompts for what is missing; a Create Examples section now covers this, along with the existing behaviour that a taken name is rejected before any further question and an out-of-range option score is rejected with All scores must be between 1 and 5.
  • Averaging undocumented. Each category asks four questions and stores Math.round(total / 4); this is now stated.
  • Data location. app.projects.file / app.projects.markdown-file are relative paths resolved against the working directory; the README now says so.
  • Feature list. "Export projects to Markdown and JSON formats" (export is Markdown only; JSON is the save file) and "Rank and sort projects by monetization, potential, feasibility and effort" (no such sort keys exist) were replaced with accurate bullets. The export command bullet said "optionally sorted"; it always sorts, by ICE score by default.
  • CONTRIBUTING. "Generating test coverage reports" was replaced by "Generating JUnit test reports (no code-coverage tool is configured)" — build.gradle has no JaCoCo or other coverage plugin; the uploaded "coverage" artifacts are the JUnit HTML reports.

No production code was changed.

Test plan

  • ./gradlew build run locally on JDK 21; build/libs/ contents and both manifests inspected
  • ./gradlew test on JDK 21 — 144 tests executed, 0 failures, 0 errors, 0 skipped
  • CI (test, build (21)) green on this branch

Deferred issues

This cycle was spent on a documentation sweep rather than the open backlog:

No tracking issue — gap found during triage.

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

dmccoystephenson and others added 2 commits October 9, 2026 02:52
The documented launch command `java -jar build/libs/Parpt-*.jar` matches
both the boot jar and the non-runnable -plain jar; in byte order the plain
jar sorts first, so java fails with "no main manifest attribute". The run
commands now name the boot jar and explain the two files.

Also: fence the install commands, document create's option form and the
per-category averaging, say where projects.json/projects.md are written,
replace feature bullets that described sorting keys and a JSON export
that do not exist, and drop CONTRIBUTING's claim of coverage reports
(no coverage tool is configured).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The example jar name would go stale on the next version bump; point at
the version in build.gradle instead.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

Test Results

144 tests  ±0   144 ✅ ±0   1s ⏱️ ±0s
 22 suites ±0     0 💤 ±0 
 22 files   ±0     0 ❌ ±0 

Results for commit b600b41. ± Comparison against base commit ae6c529.

@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (Stage A documentation sweep):

  • Scope: PASS — only README.md and CONTRIBUTING.md are modified; every hunk corrects a claim verified against source, build.gradle or the workflows.
  • Tests-new: PASS (n/a) — no public method was added.
  • Tests-fix: PASS (n/a) — no production code changed, so there is no fix to stash and re-run.
  • Sibling structure: PASS — the new "Create Examples" section mirrors the existing List/Update/Delete/Export Examples sections (fenced bash block followed by a prose paragraph).
  • Sibling renames: PASS (n/a) — nothing renamed.
  • Docs: PASS — both Phase 7 sources of truth were swept; the Roadmap checklist needed no change, and ./gradlew test is still the documented and actual test command.
  • Issue resolution: PASS (n/a) — no Closes reference; this is a gap-driven sweep.
  • Manual validation: PASS — test, build (21) and Test Results green on the PR head; locally ./gradlew test on JDK 21 executed 144 tests with 0 failures.

Findings:

  • README.md:34 — the first revision used build/libs/Parpt-0.3.0-SNAPSHOT-8-8-2026.jar as the example name, which would go stale at the next version bump. Fixed in the second commit by pointing at the version in build.gradle.
  • README.md:67-68 — the two full-option create examples use the same name, so running both back to back would hit the "already taken" message. They read as alternatives (long vs. short option form), so they were left as they are.
  • Out of diff: the plain-jar trap could be removed at the source with jar { enabled = false } in build.gradle, which would make the bare glob safe again. build.gradle is a do-not-auto-merge path and that is a build change rather than a docs change, so it was not made here.

Docs-only change, CI green, and no do-not-auto-merge path touched.

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


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 4137af6 into main Oct 9, 2026
3 checks passed
@dmccoystephenson
dmccoystephenson deleted the feat/docs-accuracy-sweep branch October 9, 2026 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant