docs: humanize wording and remove AI-style em dashes#1421
Merged
Conversation
Rework prose across the documentation site so it reads as human-written:
replace em dashes with commas, colons, semicolons, parentheses or full
stops as the sentence calls for, and drop stock phrasings
("comprehensive set of", "a wide variety of", "out of the box",
"unlocks correct behaviour"). Update the renamed migration headings and
the cross-reference anchor to keep links working. Also adds a Writing
Style section to the docs AGENTS.md to deter the same phrasings in future.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01698iGKTFkcMr51WC1grrvT
mathuo
force-pushed
the
claude/v8-docs-humanize-sec4eb
branch
from
a7cb264 to
2509342
Compare
|
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.
Description
Reworks prose across the documentation site so it reads as human-written rather than AI-generated. Rebased onto
v8-branchand targetsv8-branch.The most visible tell was the em dash: there were ~400 across the v8 doc pages. Every one is removed, replaced with whatever the sentence actually calls for (comma, colon, semicolon, parentheses, or full stop) rather than a mechanical swap. Also dropped a few stock phrasings ("a comprehensive set of events", "a wide variety of", "out of the box", "This unlocks correct behaviour").
Deliberately left alone: British spelling (behaviour, colour, localise), the en dash in numeric ranges like
v5.0–5.2, and pre-existing typos in older hand-written sections, since none of those read as AI.Also adds a Writing Style section to
packages/docs/AGENTS.mdso future doc edits avoid the same tells.Knock-on changes: removing em dashes from a few headings changed their slugs, so
## React users — action requiredbecame## React users: action requiredand the cross-reference anchor inwhats-new-v7.mdxwas updated to match. The## Renamed methodsheading keeps its explicit{#renamed-methods}anchor, so its inbound link is unaffected.Type of change
Affected packages
dockview-coredockview(vanilla JS)dockview-reactdockview-vuedockview-angulardocsHow to test
Prose-only changes; no runtime behaviour is affected. To review:
Checklist
yarn lint:fixpassesyarn formatpasses (docs package is deliberately excluded from Prettier)npm run genhas been run and generated files are up to dateyarn testpasses🤖 Generated with Claude Code
https://claude.ai/code/session_01698iGKTFkcMr51WC1grrvT