Skip to content

docs: extend writing-rules sweep to remaining docs tree#501

Merged
creatornader merged 1 commit into
mainfrom
claude/focused-pike-cc2d15
Jul 12, 2026
Merged

docs: extend writing-rules sweep to remaining docs tree#501
creatornader merged 1 commit into
mainfrom
claude/focused-pike-cc2d15

Conversation

@creatornader

Copy link
Copy Markdown
Owner

Follow-up to #496, which swept the twelve 2026-07-06 redesign docs. This extends the same writing rules to the 18 remaining docs/ files that still carried em/en dashes: six concepts docs, the nine evidence-profile docs, the dev.atrib/attribution extension spec, payments-profile.md, and the PyPI runsheet.

What changed

  • 89 em dashes and 7 en dashes removed. The dominant pattern was tier bullets in the profile docs (- \declared` — description), which become colons uniformly. Prose dashes became commas, semicolons, colons, or parentheses per sentence; en-dash ranges (§2.1–§2.5, Rules 1–5, Steps 2–3`) become plain hyphens.
  • One banned-phrase instance in the extension spec (§1, the _meta forwarding sentence) rewritten to match the wording already merged for the same sentence in the p049 draft, so the two documents agree again.
  • docs/chain-tail-corpus-scoped-charter.md needed nothing: it was authored under the rules and already complies. Verified for dashes, banned vocabulary, curly quotes, and exclamation marks.

Reviewer notes

  • No version bumps. The nine profile docs and the extension spec are version-stamped, but every change here is editorial: no facts vocabulary, tier values, normative MUSTs, links, or schemas change. If your semver policy for profile docs counts editorial edits, say so and I'll add PATCH bumps.
  • Two heading slugs changed in the extension spec (§5.2/§5.3, which contained em dashes). Verified repo-wide that only #62-receipt-block is externally linked; the changed slugs have zero references.
  • Two scanner hits deliberately left: "robustness" in payments-profile.md §Note (describes the technical cross-attestation property, which the rule permits) and "facilitator" in concepts/08 (the x402 protocol role name, not the banned verb).
  • payments-profile.md was relocated verbatim per D147; the only edits here are five en-dash ranges in its mapping tables, nothing in normative prose.

Verification

  • pnpm doc-sync: 13/13 checks passing.
  • grep -rE '—|–|load[- ]bearing' docs/ returns nothing.

Replace every em and en dash across the concepts docs, the nine
evidence-profile docs, the dev.atrib/attribution extension spec, the
payments profile, and the PyPI runsheet with colons, commas,
semicolons, or parentheses as each sentence needed; en-dash section
and step ranges become plain hyphens. Rewrite the one banned phrase
in the extension spec around the forwarding obligation it claimed,
matching the wording already merged in the p049 draft. Tier bullets
in the profile docs move from dash separators to colons.

Editorial only: no profile facts, tier values, normative MUSTs, or
links change, so no profile_version or extension version bump. The
chain-tail charter needed nothing; it already complies. Two scanner
hits stay as-is: "robustness" in payments-profile describes the
technical cross-attestation property the rule permits, and
"facilitator" in concepts/08 is the x402 protocol role name.
@creatornader creatornader merged commit b02c3cc into main Jul 12, 2026
12 checks passed
@creatornader creatornader deleted the claude/focused-pike-cc2d15 branch July 12, 2026 01:10
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