docs: rewrite README and restructure docs/ to the house contract - #219
Closed
willtheorangeguy wants to merge 1 commit into
Closed
docs: rewrite README and restructure docs/ to the house contract#219willtheorangeguy wants to merge 1 commit into
willtheorangeguy wants to merge 1 commit into
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
Contributor
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| Python |  |
Aug 14, 2026 9:41p.m. | Review ↗ |
| Docker | |
Aug 14, 2026 9:41p.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.
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 pilot for the documentation standardisation rollout.
Stacked on #218 — base is docs/standardize, so merge that first.
README: 193 lines -> 73 (budget is 120). Reference material moved into
docs/rather than dropped.Bugs fixed along the way:
github.com/.../blob/...URLs, which serve HTML. Neither image was rendering. Now served from.github/icons.docs/USAGE.mddocumented runningsend.exe/send.py, which belong to a different project.docs/COMMANDS.mdsaid thelicensecommand prints GNU GPL v3 text. This repo is MIT./PyWorkout/main/README.md#gitwere missing/blob/.Note for follow-up:
main.pyprints GPL-style boilerplate ("free software... redistribute under certain conditions") while the repo is MIT licensed. Left alone here — that is a licensing decision, not a docs one.