Repository navigation
docs: name and link the example file before every snippet include - #447
Merged
Merged
Conversation
GitHub renders a page under docs/ without expanding `--8<--`, so a reader there saw only the include line where the code should be. The sentence before each include now links the example file on GitHub, in both languages, the README says so once for the whole docs/ tree, and the development guide records the convention. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UTXhK1BtwXTBDaouEcKtpW
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
2 participants
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.
Fixes #394
Summary
GitHub renders a page under
docs/without expanding--8<--, so a reader there saw only the include line where the code should be. Rather than inlining the examples (which would duplicate whattests/test_examples.pykeeps working), the sentence before every include now names the example file and links to it on GitHub:APP_CACHE.md,BACKENDS.md,HTTP_CACHING.md(×2),JWT_CLAIMS.md(×3; the fourth already linked the file),STATE.md.SESSION.mdalready linked its two.README.mdsays once, at the top of the Documentation section, that the guides are meant to be read on the site and why.DEVELOPMENT.mdrecords the convention next to the snippet instructions, so new includes follow it.Both sites build with
zensical build --strict. Docs only, no changelog fragment.Checklist
tests/cover the change (not applicable: docs)changelog.d/<issue>.<section>.md(required for any change underfastapi_cachex/) (not applicable)uv run pre-commit run --all-filesanduv run pytestpass🤖 Generated with Claude Code
https://claude.ai/code/session_01UTXhK1BtwXTBDaouEcKtpW
Generated by Claude Code