Repository navigation
docs: restructure the README and move the details to docs/ - #37
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.
The README had grown to 2,600 words, and most of it was accurate detail in the wrong place: a 13-line paragraph on how collection works before the reader learned what the tool is for, failure semantics inside the Quickstart, and about 1,100 words narrating the page that the demo now shows.
README
It now opens with what the tool shows and who it is for, then the demo link and a screenshot of the demo with SHOP-38 chosen. After that, the order follows what a new user does:
All links stay absolute, so the PyPI page keeps working. The screenshot loads from
raw.githubusercontent.com/.../main/docs/images/demo.png, so it shows only after merge.Moved to docs/
docs/how-it-works.md: the range, rows, Jira links and link states,--jirascoping with a table of release states, and the next-tag rule.docs/page.md: the full page behaviour, split into sections, with a table of the issue reach labels.docs/report.md: thereport.jsonfields and the sample row.The text was rewritten into shorter sentences and lists, with every fact kept, and run through humanizer. Local links pass the same offline lychee check CI runs.