docs: standardize README and restructure docs/ - #60
Merged
Conversation
README 232 -> 74 lines with an 8-page docs/ folder. Moves the 88-row build index to docs/builds.md and SCRAPER_README.md to docs/scraper.md. Fixes a /blob/ hero URL that never rendered, an index row pointing at the wrong month, and nine links using an inconsistent path form. 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
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 content pass. README 232 -> 74 lines, with an 8-page
docs/folder.Where things went
docs/builds.mddocs/usage.mddocs/scraper.md(from the rootSCRAPER_README.md)docs/architecture.mdNew:
faq,troubleshooting,roadmap. Removed## Changelog,## You may also like...,## Contributors, and the Discord badge. Credits table kept.docs/legal/PRIVACY.mdandTERMS.mdlowercased via a temp filename;docs/images/deleted.Defects recorded in docs/internal/known-issues.md
The hero GIF never rendered. It used a
/blob/URL, which serves an HTML page rather than image bytes — the same fault found inMoms-Canning-Timer. Both images now come from.github/icons/.A build-index row pointed at the wrong month. January 2018 Turbo linked to
/2018/March/Turbo.md, while2018/January/Turbo.mdexists and is a different build. Anyone following the index for January's Turbo silently got March's parts and prices. Corrected.Current prices carry no timestamp.
scraper.pyrewrites them daily, but nothing records when a file was last updated — so if the workflow has been failing for a month, stale prices look exactly as authoritative as fresh ones. A "prices as of" line written by the scraper would fix it in one change;roadmap.mdcalls it the most valuable item there.Two inconsistent link forms in the index. Most rows were root-relative (
/2021/...), nine were not. Both resolved from a README at the repository root, so the inconsistency was invisible — until the table moved intodocs/, where nine rows broke and the rest did not. Normalised.CC BY 4.0 over build lists published by the magazine, which were not this repository's to grant. Part lists are closer to fact than expression so the practical risk is low, but the statement is inaccurate — same pattern as
FBI-Application-Guide. A provenance notice would be more honest, and the README now carries an## Attributionsection.76 PCPartPicker links use
willtheornageguyrather thanwilltheorangeguy. It is consistent across all 76, which suggests it is genuinely the account name rather than a typo — but worth confirming once, because if it is wrong every PCPartPicker link in the archive is dead.Explained rather than listed
Why three representations exist: PCPartPicker is live and buyable but cannot hold a historical price; the Markdown diffs and works offline; the website browses. Only the latter two preserve the printed price, and that comparison is the archive's whole point. The CAD/USD split reflects where each is read.
The git history is already a price series. Because the scraper rewrites prices in place daily, every commit records what those parts cost that day — a genuinely interesting dataset that nothing surfaces.
One upstream, no fallback. Every current price comes from PCPartPicker; a layout change there stops all price updating.
Tooling note
Fixing this repo surfaced a gap in the sweep's own verifier: it tested relative links without URL-decoding, so any path containing
%20was reported broken. It now decodes first — which is what let the nine genuinely broken rows be separated from 57 false positives.Verification passes: 74 lines, no orphan nav anchors, no forbidden sections, every relative link resolves.
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