Skip to content

docs(readme): rewrite em-dash constructions as plain sentences - #457

Merged
Leo310 merged 1 commit into
devfrom
docs/readme-punctuation
Sep 3, 2026
Merged

docs(readme): rewrite em-dash constructions as plain sentences#457
Leo310 merged 1 commit into
devfrom
docs/readme-punctuation

Conversation

@Leo310

@Leo310 Leo310 commented Sep 3, 2026

Copy link
Copy Markdown
Member

Removes all twelve em dashes from the README, matching the pass already applied to the org description, the repo description, and the org profile README.

Punctuation only. No claim, link, or command changed; the diff is 13 lines rewritten in place.

Each dash was resolved in the way that suited the sentence, rather than swapping one mark for another everywhere:

  • Split into two sentences where the dash joined two independent clauses (the no-provider line, the install line, the contributing bullet).
  • Colon where it genuinely introduced a list or gloss (the opening pitch, the six documentation bullets).
  • Parentheses for the bracketing pair in Network use, where dropping both dashes would have run the clauses together.
  • Rephrased the two that were leaning on the dash to attach a fragment (smartsecondbrain.dev now "has the …", and "That's long finished, but we keep …").

@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The README replaces twelve em-dash constructions with sentences, colons, parentheses, and minor rephrasing while preserving its claims, links, and commands.

  • Clarifies introductory, installation, network-use, contribution, and project-history prose.
  • Standardizes documentation-list descriptions with colons.

Confidence Score: 5/5

The PR appears safe to merge with no actionable issues identified.

The changes only revise punctuation and sentence construction while preserving documentation claims, destinations, commands, and rendering structure.

Important Files Changed

Filename Overview
README.md Punctuation-only prose revisions preserve the README’s meaning, links, commands, and Markdown structure without introducing actionable issues.

Reviews (1): Last reviewed commit: "docs(readme): rewrite em-dash constructi..." | Re-trigger Greptile

@Leo310
Leo310 merged commit c13e0a1 into dev Sep 3, 2026
3 checks passed
@Leo310
Leo310 deleted the docs/readme-punctuation branch September 3, 2026 09:17
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