docs: repo-wide v1.2.0 consistency pass (audit)#42
Merged
Conversation
A full link + content audit of main. All internal links and anchors resolve, all external URLs are live (PyPI 1.2.0, docs site, blob links) — no broken references. Fixed the stale content the audit surfaced: - README: status badge v1.0 -> v1.2.0; "Latest release v1.0" section rewritten to lead with v1.2.0 (--deep) and v1.1.0 (CSV); How-it-works Rule 12 line now notes the --deep WARNING floor. - ml/README: intro, pipeline diagram and the scp reproduce step said cnn_v3/v2 "currently shipping" while later chapters correctly describe cnn_v4_stereo — intro now matches (v4 stereo, balanced acc 0.905, specificity 95.1%). - docs/roadmap-formats: "AAC/Opus/Vorbis near-impossible" rescoped — corrected per v1.2.0 (caught on full-range via --deep; band-limited is the real limit). - docs/technical-details: pseudocode WARNING ceiling 60 -> 54 (matches the thresholds table); Rule 12 "Scoring" note cross-references the --deep floor; pseudocode now shows rule_12. - .github/SECURITY: supported versions 0.16.x -> 1.2.x. - docs/getting-started: "scans .flac" -> lossless audio (FLAC/WAV/ALAC/APE). Docs build clean under -W. Docs-only; no code touched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
A full audit of
mainto make the repo immaculate after the v1.2.0 release.Audit result
#anchoracross all 25 tracked.mdfiles resolves — 0 broken.flac-detective+/1.2.0/), the docs site (incl. the newstart-herepage), theblob/main/...cross-tree links, referenced issues. All200.sphinx -W.Stale content fixed
v1.0→v1.2.0; the "Latest release — v1.0" section rewritten to lead with v1.2.0 (--deep+ WARNING floor) and v1.1.0 (CSV triage); the How-it-works Rule 12 line now notes the--deepfloor.scpreproduce step still called cnn_v3/cnn_v2 "currently shipping" while the later chapters correctly describe cnn_v4_stereo — the intro now matches (v4 stereo, balanced acc 0.905, specificity 95.1%). The historical "six attempts" narrative (which legitimately mentions v2/v3) is untouched.--deep; band-limited material is the real fundamental limit).60→54(matches the thresholds table);rule_12added to the pseudocode; Rule 12 "Scoring" note cross-references the--deepfloor.0.16.x→1.2.x..flac" → lossless audio (FLAC/WAV/ALAC/APE).Docs-only — no code touched.
🤖 Generated with Claude Code