Skip to content

docs: plainer tone across the documentation site - #129

Merged
srikanth-bitdynamics merged 2 commits into
mainfrom
docs/plainer-tone
Aug 3, 2026
Merged

docs: plainer tone across the documentation site#129
srikanth-bitdynamics merged 2 commits into
mainfrom
docs/plainer-tone

Conversation

@srikanth-bitdynamics

Copy link
Copy Markdown
Owner

A copyedit pass over the documentation for tone and readability, covering the guides and the rest of the user-facing tree (concepts, guides, reference).

Tone only:

  • signpost headings and preambles dropped
  • repeated "X, not Y" antithesis thinned to where it actually disambiguates
  • mechanical bold paragraph labels and emphatic italics removed
  • em dashes replaced with commas, colons, parentheses, or sentence splits
  • headings sentence-cased; inflated words replaced with plainer ones

Nothing technical changed. Verified over every edited file: fenced code blocks byte-identical, link targets unchanged, inline-code identifiers preserved, and every intra-doc anchor still resolves (cross-linked headings kept verbatim). The site builds.

Drop signpost prefixes and inflated phrasing, sentence-case the headings,
replace em dashes, and remove mechanical bold. No code, command, link, or
technical claim changed.
Extends the same tone pass to the rest of the docs tree: drop signpost
headings and preambles, thin the repeated antithesis phrasing, remove
mechanical bold lead-ins and emphatic italics, and replace em dashes.
Cross-linked headings are left verbatim so anchors keep resolving. No code
block, command, link, number, or technical claim changed.
@srikanth-bitdynamics
srikanth-bitdynamics merged commit 86f4b53 into main Aug 3, 2026
7 checks passed
@srikanth-bitdynamics
srikanth-bitdynamics deleted the docs/plainer-tone branch August 3, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant