docs: apply writing guidelines across the docs site - #87
Merged
Conversation
Contributor
|
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.
Applies the writing conventions from the global CLAUDE.md to every docs page except
guide/quick-links.md, which was already written to them in #86.No behavioural or factual changes, prose only.
What changed
- **Label** — textto- **Label**: text.***Settings -> Downloads***,***Settings -> General -> API Key***,***Live***/***Reconnecting...***.3. Serving — being a peer to others->3. Serving as a peer to others.—,→,…, smart quotes) removed from prose, including the mounts table in getting-started.Not changed
how-it-works.mdkeep→and…inside message labels, since->there collides with mermaid's own arrow syntax.[operationId].paths.tskeeps the em dash in its generated page titles, where it separates title from section rather than acting as a pause.Renamed headings keep their existing anchors (verified in the built HTML), and
bun run buildpasses.