docs: correct top-level documentation to the shipped behaviour - #153
Merged
Merged
Conversation
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
README, RELEASING, AGENTS, the crate overview in
src/lib.rs, and the comments inci.ymlandhk.pklnow say only what the repository does today. This PR changes documentation and comments only. No code, workflow step or hook step changes.Closes #129
Changes by path
README.mdplanandapplyreport andapplyskips. There is no keep/discard/skip prompt; the only prompt is the single yes/no confirmation insrc/command.rs.doctor: lists the nine checks insrc/doctor/mod.rs. The claims about caches at their limit, integrations gone stale, and tools installed but not reachable are gone, because no such checks exist.bx self-upgrade --force, the2exit code of--check, thePATHargument thatbx addandbx rmrequire (without one they refuse and point tobx init), and their2exit codes.RELEASING.mdreleases_createdoutput gatesbuild, andupload-assetsattaches the tarballs and.sha256files.v0.1.0andv0.1.1already exist.AGENTS.md: is now a symlink toCLAUDE.md. The two copies had diverged, and AGENTS.md was missing the sentence about cached tool activation output.src/lib.rs: the doctor sentence in the crate overview now names all nine checks. It previously named seven and left outreferencesandorphans..github/workflows/ci.yml: the comments on the uv pin, the action-ref resolver and its self-check now state current intent in a few lines each. Removed: review-round history ("until round 5", "over-correction", "survived a round"), line-number citations into another repository, and the claim that checkout is "the one ref" this step cannot catch. The last line now says it cannot report a broken ref in this job's own setup. No step changed.hk.pkl: the header now lists the commit-msg hook (convco) and the pre-commit shellcheck, actionlint and line-check steps.Decisions taken
Taken: the documentation is wrong; it is corrected to the shipped behaviour, and the unbuilt capabilities are filed separately without the label (accepted unrebutted)
Rejected: the code is wrong - building them would be a feature, out of scope for a cleanup
Reverses: restore the removed README sentences
Taken: AGENTS.md becomes a symlink to CLAUDE.md (accepted unrebutted)
Rejected: copy the missing sentence across - they would diverge again
Reverses: replace the symlink with a copy
add,rmandself-upgrade --checkTaken: one paragraph under the existing "Exit codes" table, which already documents
plan's codesRejected: one table per command - it repeats the same four codes
Reverses: move the paragraph
Taken: "re-run that run's failed jobs" - a full re-run starts the release job again, which finds nothing new to release, so
buildandupload-assetsare skippedRejected: keep "re-run the workflow"
Reverses: restore the previous sentence
Validation
mise run format-check,mise run lint,mise run testandmise run coverage.mise run actionlintandmise run line-checkare clean. The pre-commit hook also ran convco, shellcheck, actionlint and line-check.Coverage gaps
src/main.rs,src/command.rs,src/adopt.rs,src/upgrade.rs,src/doctor/mod.rsand.github/workflows/release-plz.yml.Follow-up
Decision 1 says the unbuilt capabilities are filed separately without the label. They are in #146: the drift prompt and the doctor cache and staleness checks. The removed "tells you what it saved" claim and the "installed but not reachable" doctor wording describe nothing planned, so they were removed with no follow-up.