docs: prose pass over README and published docs - #202
Merged
Merged
Conversation
Benchmark gate✅ gate passed
Gated (fails the build): |
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.
Prose pass over the README and the published docs (everything mkdocs builds;
docs/agents/anddocs/adr/are excluded and untouched). Code blocks, inline code, commands, link targets and admonition syntax are unchanged; a script diffed every fenced block, inline-code span and link target againstmain. The only inline-code span removed isfaststream-outboxinside a cut closer incomparison.md.What changed
**TL;DR.**labels, bold-led checklist and list items, and emphasis bold.docs/index.md: decorative→arrows and the italic*concept:*/*reference:*/*step-by-step:*labels in the page index are gone.dlq.md: one sentence that read as version history ("Default behavior is unchanged when...") now describes current behavior.Social card
docs/assets/social-card.pngis replaced with the card regenerated from the current repo description in modern-python/.github#125.Checks
just lint-ci: passpytestagainst a throwawaypostgres:17container: 624 passedmkdocs build --strict: pass