Repository navigation
docs: link the documentation site at the top of the README - #21
Merged
Merged
Conversation
The link sat below the table of contents, where few readers get. It now follows the description, with one sentence saying the site tracks master while a PyPI release's README matches that release. Chose the site root over deep links (/reference/, /adr/): a release's README stays on PyPI for good, those paths sit outside what mkdocs --strict checks, and a renamed section would turn them into permanent 404s.
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.
Moves the documentation site link from below the table of contents to right after the description, so it is the first thing a reader on GitHub or PyPI sees.
/reference/-style paths are outside whatmkdocs --strictchecks, and a renamed section would turn them into permanent 404s.Verification: pytest (387 passed),
check_file_length.py,mkdocs build --strict, a dry run ofpin_readme_links.pyfor v3.0.1 (31 links pinned),twine check --strict./code-review high: 5 findings. Fixed: the site links contradicting the release-pinning promise, the duplicated architecture/ADR links, and the deep links not covered by CI. Not changed: the Docs badge next to the callout, kept as the standard entry point (a URL change touches the badge, the callout and pyproject; accepted).