Skip to content

docs: replace hyphen-as-dash prose with natural sentences - #349

Merged
joshua-temple merged 1 commit into
mainfrom
docs/copyedit-dashes
Jun 25, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/copyedit-dashes

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Problem

Several docs pages used a hyphen as a sentence-level dash or parenthetical break (the - X - and trailing - clause constructions), which reads as an unnatural writing tic.

Fix

Copyedited the affected prose into natural sentences: split into two sentences, or used a comma or colon where that was the cleanest option. Scope was prose only.

Preserved everywhere: compound-modifier hyphens (platform-enforced, fail-closed, multi-env, etc.), Markdown list-item markers, table structure and empty-value cells, code spans, inline flags, URLs, file paths, and version strings. The repo's no-em-dash rule was respected; no em/en dashes were introduced.

Verification

  • 8 files changed, 30 dash-constructions rewritten.
  • Frontmatter intact and code fences balanced on every edited page.
  • Docs site build not run (local Node is v20; Starlight needs >=22); markdown validated structurally instead.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit d4cb39b into main Jun 25, 2026
15 checks passed
@joshua-temple
joshua-temple deleted the docs/copyedit-dashes branch June 25, 2026 01:33
@joshua-temple joshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant