docs: fix repo-relative links in README + CONTRIBUTING#39
Merged
Conversation
Fix repo-relative .md links in README and CONTRIBUTING (broken on PyPI), plus a one-shot lychee audit of the built docs site. Three line edits + one tool run; single-PR scope. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
9-task plan: branch, three single-line edits across README + CONTRIBUTING, build docs, run lychee external-link audit (with linkchecker fallback), triage + fix any findings, sanity build, push and open PR. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The rendered docs page already exposes an Edit-on-GitHub link via mkdocs's edit_uri + content.action.edit theme feature; no need for CONTRIBUTING.md to also point at the source file. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Matches modern-di's README footer pattern. Co-Authored-By: Claude Opus 4.7 (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.
Summary
README.md:91— Middleware guide link now points athttps://httpware.modern-python.org/middleware/(was the repo-relativedocs/middleware.md, which breaks on PyPI and routes to raw markdown on GitHub).README.md:142— License link is now an absolute GitHub URL (was./LICENSE, also broken on PyPI).CONTRIBUTING.md:6— Source-pointer link is now an absolute GitHub URL (was a repo-relative.mdlink).linkchecker 10.6.0against the rendered HTML; 75 links checked, 0 errors, 0 warnings. No broken external URLs found.Spec:
planning/specs/2026-06-08-readme-link-cleanup-design.mdNot changed
docs/*.mdlinks ([Errors reference](errors.md)style) — these are the standard mkdocs convention; mkdocs rewrites them to clean URLs at build. Changing them would breakmkdocs serve.CLAUDE.mdplanning-file links — internal AI-guidance only, not user-facing.docs/index.md:174Engineering Notes — already an absolute GitHub URL by design (planning/engineering.md isn't in the published site).Test plan
mkdocs build --strictpasses (no docs content changed).curl -sIreturns 200 on each of the three new link targets.(docs/*.md)or(./*)repo-relative links in README.md..mdlinks in CONTRIBUTING.md.linkcheckeraudit produced a clean report (0 errors, 0 warnings, 75 links).🤖 Generated with Claude Code