Skip to content

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

Merged
mhodzic93 merged 1 commit into
mainfrom
chore/external-voice-entity-rule
Aug 10, 2026
Merged

mhodzic93 merged 1 commit into
mainfrom
chore/external-voice-entity-rule

Conversation

@mhodzic93

Copy link
Copy Markdown
Contributor

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

Our own PR reviewer caught an — rendering as a visible em-dash on the
Runners pricing page while the guard passed clean, because the entity is seven
ASCII bytes and nothing was looking for it. The canonical doc now bans the
entity forms explicitly and explains the second reason they are worse than the
literal character: inside a multi-line JSX text run an entity makes the
transform drop the space after an adjacent expression.

The doc also now states the known gap plainly, that the in-product dashboard
copy in web-client is in scope but not yet swept, so a green guard is not read
as the whole product being clean.

Doc-only, and identical to the copies in the other three repos. No entity dashes
exist in this repo; this keeps the four copies from drifting.

Co-Authored-By: Claude Opus 5 (1M context) noreply@anthropic.com

Our own PR reviewer caught an `—` rendering as a visible em-dash on the
Runners pricing page while the guard passed clean, because the entity is seven
ASCII bytes and nothing was looking for it. The canonical doc now bans the
entity forms explicitly and explains the second reason they are worse than the
literal character: inside a multi-line JSX text run an entity makes the
transform drop the space after an adjacent expression.

The doc also now states the known gap plainly, that the in-product dashboard
copy in web-client is in scope but not yet swept, so a green guard is not read
as the whole product being clean.

Doc-only, and identical to the copies in the other three repos. No entity dashes
exist in this repo; this keeps the four copies from drifting.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@buildpulse-v2 buildpulse-v2 Bot added agent-reviewed Reviewed - approved and removed agent-reviewed Reviewed - approved labels Aug 10, 2026

@buildpulse-v2 buildpulse-v2 Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agent code review

Walkthrough

This is a documentation-only PR that adds 17 lines to EXTERNAL-VOICE.md, the canonical em-dash style rule shared across four repos. The two additions are: (1) an explicit ban on HTML entity forms of dash characters (&mdash;, &#8212;, &#x2014;, spaced &ndash;) with rationale, and (2) a "Known gap" section at the end of the Enforcement table honestly documenting ~90 un-swept literal em-dashes remaining in the web-client/src/app/organizations/** dashboard copy. No code is changed.

Findings

No issues found.

Verdict

Clean, well-reasoned documentation update. The entity-dash paragraph closes a real gap (ASCII-invisible to character searches), and the "Known gap" section sets accurate expectations without overstating coverage. The prose is clear and consistent with the existing file's register. One changed file, fully read. Pre-APPROVE checklist all green.

Confidence

HIGH — single doc-only file, complete diff read, no code logic involved.

💡 Tips for working with the BuildPulse reviewer
  • Re-review on demand — comment @buildpulse review on the PR (/buildpulse review also works). The fresh review bills the requester's seat.
  • Teach it by replying to a finding — reply to any inline comment: "we never do X here" becomes a standing rule for this repository (acknowledged in-thread, not raised again); "not in this PR" mutes the topic for this PR only. Replies are free. Org admins can view or remove learned rules on the AI Features page.
  • Every push is re-reviewed automatically — smaller PRs get a fresh full review, larger ones get a delta review of what changed since the last look; an "Update branch" merge with an unchanged diff carries the previous verdict forward without a new billed review.
  • Draft PRs are skipped until marked ready for review (repositories can opt in to draft reviews on the AI Features page).

@mhodzic93
mhodzic93 merged commit 76e2ef6 into main Aug 10, 2026
2 checks passed
@mhodzic93
mhodzic93 deleted the chore/external-voice-entity-rule branch August 10, 2026 12:58
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