Skip to content

docs: take the em-dashes out of the copy that ships to the registries - #18

Merged
mohameduk merged 1 commit into
mainfrom
no-em-dashes
Sep 2, 2026
Merged

mohameduk merged 1 commit into
mainfrom
no-em-dashes

Conversation

@mohameduk

Copy link
Copy Markdown
Owner

House rule. These three files are the ones strangers actually read: PyPI renders ubag-python/README.md, npm renders ubag-node/README.md, and the npm description is the single line shown in search results.

Rewritten rather than punctuation-swapped, so the sentences still read:

before after
UBAG Web Layer — agent identity... a colon
Asymmetric by design — agent identity by design, so agent identity
site_meta is OPTIONAL — Branch B... two sentences

The description also stops being stored as a \u2014 escape. npm rewrote that to a literal character on every npm version, which put an unrelated line in the diff of the release commit.

Deliberately not in scope

The root README.md has 45, CHANGELOG.md has 18, and there are roughly 50 more across source comments. That is a large prose diff worth reading sentence by sentence rather than sweeping, and none of it ships to a registry. Happy to do it as its own pass.

Python 105 passed, Node 113 passed.

🤖 Generated with Claude Code

House rule, and these three files are the ones strangers actually read: PyPI
renders ubag-python/README.md, npm renders ubag-node/README.md, and the npm
description is the one line shown in search results.

Rewritten rather than punctuation-swapped, so the sentences still read:

  "UBAG Web Layer - agent identity..."     becomes a colon
  "Asymmetric by design - agent identity"  becomes "by design, so agent identity"
  "site_meta is OPTIONAL - Branch B..."    becomes two sentences

The description also stops being stored as a \u2014 escape, which npm rewrote to
a literal character on every `npm version` and put an unrelated line in the diff
of the release commit.

Not touched: the root README has 45 and CHANGELOG has 18, plus roughly 50 more
across source comments. That is a large prose diff worth reading sentence by
sentence rather than sweeping, and none of it ships to a registry.

Python 105 passed, Node 113 passed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mohameduk
mohameduk merged commit 524ad7d into main Sep 2, 2026
6 checks passed
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