Skip to content

chore(brand): em-dash sweep across prose + remove submitted CFP draft#224

Merged
amcheste merged 2 commits into
developfrom
brand/align
May 11, 2026
Merged

chore(brand): em-dash sweep across prose + remove submitted CFP draft#224
amcheste merged 2 commits into
developfrom
brand/align

Conversation

@amcheste-ai-agent
Copy link
Copy Markdown
Contributor

@amcheste-ai-agent amcheste-ai-agent Bot commented May 11, 2026

Summary

Brand-alignment pass against the alanchester-brand voice rules. 196 em-dashes swept across 22 prose files, plus removal of the now-submitted CFP draft.

This is the prose half of the audit. The dashboard template internal/dashboard/templates/layout.html is intentionally out of scope — it's a tool surface, not a brand surface, and its semantic UI palette stays.

What's in this PR

Em-dash sweep (22 files)

Mechanical replacement: . , with capitalization of the following letter when it was lowercase. Code blocks and markdown table rows protected from substitution. Per the theming-prompt's "rendered prose vs code structure" rule.

Files:

  • Root: README.md, CONTRIBUTING.md, AGENTS.md, ARCHITECTURE.md, SECURITY.md
  • Docs index: docs/README.md, docs/index.md, docs/helm-values.md
  • Explanation: docs/explanation/{coordination,index,operations,resources}.md
  • How-to: docs/how-to/index.md, install (gke/aks/eks), operate (budget-alerts/expose-dashboard/shared-storage)
  • Tutorials: docs/tutorials/{getting-started,index}.md
  • Reference: docs/reference/index.md

Post-sweep audit

The mandatory grep -nE '\. [a-z]' audit found 5 matches:

  • 4 are abbreviation false positives (e.g., Approx., vs.) — left as-is.
  • 1 real awkward continuation in docs/how-to/operate/expose-dashboard.md: the original em-dash was bridging a comma-clause (namespace — e.g. when teams...). Mechanical sweep produced namespace. E.g. when teams... which reads as two fragments. Manually fixed to namespace, e.g. when teams....

Deletion: docs/cfp/cfp-draft.md

The CFP was submitted; the draft no longer needs to live in the repo. Removing it also eliminates 30 em-dashes that the sweep would have hit and that have specific rhetorical pacing worth not mechanically disturbing. The now-empty docs/cfp/ directory is removed implicitly (git doesn't track empty directories).

What's intentionally NOT in this PR

  • internal/dashboard/templates/layout.html. The dashboard's 7-phase status palette (#f3f4f6/#374151, #fef3c7/#92400e, #dbeafe/#1e40af, #d1fae5/#065f46, #fee2e2/#991b1b) is semantic UI, not brand surface. It stays unchanged.
  • README badges — already aligned on develop (Version 0B0B0C, License 1F4D3A) via PR chore: align badges and description to brand #220.
  • Bannerassets/banner.png already exists on develop.
  • Repo topics — flagged as a separate manual gh repo edit decision.

Voice-audit residue

After the sweep, the 4 remaining . [a-z] matches are all real-English abbreviations. Listed here for the record so the next audit pass doesn't re-flag them:

File Line Abbreviation
docs/explanation/operations.md 13 Approx. (table header)
docs/explanation/resources.md 161 e.g. (inside Mermaid diagram)
docs/explanation/resources.md 239 e.g. (parenthetical)
docs/how-to/operate/expose-dashboard.md 107 e.g. (the fixed line, comma-restored)
docs/reference/api/index.md 140 vs.

Verification

  • git diff develop --name-only → 22 modified + 1 deleted. No edits to layout.html, assets/, or .github/.
  • No em-dashes in newly-rewritten prose (only in code blocks and table cells, all protected).
  • All audit matches accounted for.
  • PR targets develop (matches branch model).

🤖 Generated with Claude Code

No-Linear-Issue: brand-alignment doc cleanup, no associated Linear ticket

Brand alignment pass against the alanchester-brand voice rules.
196 em-dashes swept across 22 prose files. The mechanical sweep
replaces ` — ` with `. ` (period + space) and capitalizes the
following letter when it was lowercase. Code blocks and markdown
table rows are protected from substitution.

Files swept:
  README.md, CONTRIBUTING.md, AGENTS.md, ARCHITECTURE.md,
  SECURITY.md, docs/README.md, docs/index.md, docs/helm-values.md,
  docs/explanation/{coordination,index,operations,resources}.md,
  docs/how-to/index.md,
  docs/how-to/install/{aks,eks,gke}.md,
  docs/how-to/operate/{budget-alerts,expose-dashboard,
    shared-storage}.md,
  docs/tutorials/{getting-started,index}.md,
  docs/reference/index.md

Post-sweep audit (`grep -nE '\. [a-z]'`) found 5 awkward
continuations after mechanical replacement. 4 are abbreviation
false positives (`e.g.`, `Approx.`, `vs.`) and left as-is. 1 was
a real awkward continuation in
docs/how-to/operate/expose-dashboard.md where the original
em-dash separated a comma-clause; restored to comma form.

Out of scope (intentional):
- internal/dashboard/templates/layout.html status colors. The
  dashboard is a tool surface, not a brand surface; the semantic
  UI palette (gray/amber/blue/green/red phase colors) stays.
- docs/cfp/cfp-draft.md is deleted in this PR. The CFP was
  submitted, the draft no longer needs to live in the repo.
  Removing it eliminates 30 em-dashes that otherwise would have
  been flagged in scope.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: amcheste <13696614+amcheste@users.noreply.github.com>
The brand-alignment sweep in 25fcf54 has no associated Linear
ticket. The validate.yml Linear-ref check requires either an
AMC-N reference or a No-Linear-Issue trailer. PR body was
updated with the trailer; this empty commit re-triggers the
synchronize event on the workflow.

No-Linear-Issue: brand-alignment doc cleanup, no associated Linear ticket

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: amcheste <13696614+amcheste@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants