Repository navigation
Bring an existing README to the standard in update mode - #32
Merged
Merged
Conversation
Update mode now fixes what is outdated, unsupported, or duplicated and brings the structure to the README standard, keeping the author's prose and logo. Scenario 5's invariant follows, and its re-run passes. Closes #25.
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.
What this changes
Update mode brings an existing README to the README standard — header shape, section names and order — while keeping the author's prose and the existing logo. Scenario 5's invariant now expects that, instead of "only the outdated parts change".
Closes #25
Why
#25 recorded a conflict: scenario 5 allowed only outdated commands, links and versions to change, while
SKILL.mdand the README standard (#17) restructure the header and section names. The maintainer decided the standard wins.SKILL.mdUpdate mode: fix what is outdated, unsupported, or duplicated, and bring the structure to the standard inreferences/readme-structure.md, keeping the author's prose and logo inside it.tests/scenarios.mdscenario 5: the invariant now requires every outdated item fixed and the structure to follow the standard, with no section invented beyond what the repository evidences.Checks
node --test tests/repository.test.mjspassesnode --test tests/evals/*.test.mjspassesCHANGELOG.mdupdated under the current unreleased headingSKILL.mdis changed everywhere it appears inreferences/— no reference restated the old "only what is outdated" ruleClaims this adds to the documentation
README.mdchanged. The quick start's colour values were computed by the agent from the code; spot-checked by hand (#336699→#668cb3at the second step).