Skip to content

docs: sync EXTERNAL-VOICE.md with the entity-dash rule #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhodzic93 merged 1 commit into from
Aug 10, 2026
Merged

docs: sync EXTERNAL-VOICE.md with the entity-dash rule #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions EXTERNAL-VOICE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ it reads as a find-and-replace job rather than a rewrite.
significant spaces get trimmed by a formatter, which silently inverts what the
rule says.)

And no HTML entity dashes: `—`, `—`, `—`, or a spaced
`–`. They render as exactly the characters above, but they are plain ASCII
in source, so a search for the character does not find them. In JSX they are
worse than a rendering nit: an entity inside a multi-line text run makes the
transform drop the space after an adjacent expression, which has already shipped
`vs the 30before` to production once.

## How to rewrite, by job

An em-dash does at least five different jobs. Each has its own correct fix.
Expand Down Expand Up @@ -90,3 +97,13 @@ model swaps in a spaced hyphen and you have gained nothing.
Anything not in that table is on the author. The guards exempt this file, since
it necessarily quotes the character it bans, and they exempt fenced code blocks,
because a dash inside sample output belongs to the code and not to our voice.

### Known gap

`web-client/src/app/organizations/**` is in scope by this document and is NOT
yet swept: roughly 90 literal em-dashes remain in the in-product dashboard copy.
The guard covers marketing, the explainer prompts, and the invitation emails,
and it bans entity dashes across all of `src`, so the untouched copy cannot get
worse in the way that is hardest to see. Sweeping the dashboard tree is
follow-up work, deliberately not folded into the PR that installed the rule.
Do not read the guard passing as the whole product being clean.
Loading