Repository navigation
Correct README and CONTRIBUTING drift found in a docs sweep - #60
Merged
Merged
Conversation
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>
Member
Author
|
Self-review rubric (Stage A documentation sweep):
Findings:
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Stage A documentation accuracy sweep: every claim in
README.mdandCONTRIBUTING.mdwas checked against the source,build.gradleand the two workflows. Drift found and corrected:./gradlew buildwrites bothParpt-<version>.jar(boot jar) andParpt-<version>-plain.jar(noMain-Classin its manifest — confirmed by reading both manifests). The documentedjava -jar build/libs/Parpt-*.jarexpands to both; in byte order the plain jar sorts first, sojavagets the non-runnable jar and fails withno main manifest attribute. The Installation, Getting Started and Usage reporting commands now nameParpt-<version>.jar, and the two jars are explained.bashblocks.createoptions undocumented.CreateProjectCommandaccepts-n/-d/-i/-c/-e/-r/-fand 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 withAll scores must be between 1 and 5.Math.round(total / 4); this is now stated.app.projects.file/app.projects.markdown-fileare relative paths resolved against the working directory; the README now says so.exportcommand bullet said "optionally sorted"; it always sorts, by ICE score by default.build.gradlehas no JaCoCo or other coverage plugin; the uploaded "coverage" artifacts are the JUnit HTML reports.No production code was changed.
Test plan
./gradlew buildrun locally on JDK 21;build/libs/contents and both manifests inspected./gradlew teston JDK 21 — 144 tests executed, 0 failures, 0 errors, 0 skippedtest,build (21)) green on this branchDeferred issues
This cycle was spent on a documentation sweep rather than the open backlog:
app.projects.fileinapplication.yaml(a do-not-auto-merge path) and moves where existing users' data is read from; that default-location choice is left for the maintainer.build.gradle(do-not-auto-merge) and is larger than a single cycle.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