docs: standardize README and docs/ structure - #220
Merged
Conversation
Wave 2 pilot. README goes from 193 lines to 73, against a 120-line budget. Reference material moved into docs/ rather than deleted. README: - Logo and hero now load from willtheorangeguy/.github/icons via raw.githubusercontent.com. The previous URLs used github.com/blob/, which serves an HTML page, so neither image had been rendering. - Sections follow the house set: Key Features, Installation, Usage, Documentation, Support, Contributing, Credits, License. Changelog and "You may also like..." are dropped account-wide. - Installation shows the one fastest path (pip); the other three moved to docs/installation.md. Usage shows one real session instead of a command dump. - Dropped the Discord badge and link, and the broken self-links of the form /PyWorkout/main/README.md#git that were missing /blob/. docs/: - USAGE.md, COMMANDS.md, TESTING.md renamed to lowercase, and CUSTOMIZATION.md to configuration.md. Renames are two-step, since a case-only git mv is a silent no-op on a case-insensitive filesystem -- and GitHub is case-sensitive, so the links would have 404'd. - Added installation.md and development.md. - usage.md previously documented running send.exe and send.py, which belong to a different project. PyWorkout's entry point is main.py. - commands.md claimed the license command prints GNU GPL v3 text. This repo is MIT licensed; the command prints a copyright line and warranty disclaimer, which is what it now says. - configuration.md notes that editing main.py has no effect on a pip-installed copy or the packaged executable. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
All five images are byte-identical in .github/icons/PyWorkout/ and the README and docs/ pages already reference them there by absolute URL. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
Contributor
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| Python |  |
Aug 17, 2026 11:58p.m. | Review ↗ |
| Docker | |
Aug 17, 2026 11:58p.m. | Review ↗ |
Important
AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.
… pages Brings docs/ up to the revised standard page set. PLANNING.md moves into docs/roadmap.md alongside the defects found while documenting. api.md omitted: there is no API surface. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
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
1 participant
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.
Wave 2 for
PyWorkout— the content pass. Supersedes #219, which GitHub closed when its base branchdocs/standardizewas merged and deleted. Rebuilt directly onmain, so it is now a plain single-base PR.README: 193 -> 73 lines
Kept identity, features, one install path, one example, and links. Everything else moved into
docs/.docs/ restructured to the house contract
README.md(index) plus seven lowercase pages:installation,usage,commands,configuration,development,testing.Renames went through a temp filename in two steps. Writing
docs/usage.mddirectly is a silent no-op on a case-insensitive Windows filesystem — git keeps trackingUSAGE.md, GitHub stays case-sensitive, and everydocs/usage.mdlink 404s.git statuswas checked forRrename entries on each one.Pre-existing bugs fixed along the way
github.com/.../blob/..., which serves an HTML page rather than image bytes. Now on.github/icons/PyWorkout/, verified 200.docs/USAGE.mddocumented runningsend.exeandsend.py— those belong to a different project entirely. PyWorkout's entry point ismain.py.docs/COMMANDS.mdclaimed thelicensecommand prints GNU GPL v3 text, but this repo is MIT./PyWorkout/main/README.md#git, missing the/blob/segment.docs/images/deleted — all five files are byte-identical under.github/icons/PyWorkout/.Flagged, not changed
main.pyprints GPL boilerplate at startup ("ABSOLUTELY NO WARRANTY... free software... redistribute under certain conditions") with a 2021-2024 copyright line, while the repo is MIT-licensed. That is a licensing decision rather than a documentation one, so the code is untouched.Verification passes: 73 lines, no orphan nav anchors, no
Changelog/You may also like, no broken relative links, no survivingdocs/imagesreference, no uppercasedocs/*.md.Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
🤖 Generated with Claude Code
https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R