Skip to content

docs: strip em/en dashes and tighten AI-tell prose#32

Merged
albedosehen merged 1 commit into
mainfrom
docs/voice-pass
May 8, 2026
Merged

docs: strip em/en dashes and tighten AI-tell prose#32
albedosehen merged 1 commit into
mainfrom
docs/voice-pass

Conversation

@albedosehen
Copy link
Copy Markdown
Contributor

Voice pass over the docs site shipped in #31.

User flag: chapters were leaning AI-generated. Operators in 2026 read past that quickly.

Changes:

  • Removed every em-dash (U+2014) and en-dash (U+2013). Bullet-list definitions now use a period (name(). desc.) instead of a dash separator. Sentence asides go to periods or parens.
  • Cut hedging adjectives (comprehensive, robust, seamless, etc.).
  • Dropped section transitions and other LLM tells.
  • Replaced filler triplet bullet rhythms with prose where the list pattern wasn't earning its keep.
  • Matched the README's voice: terse, opinionated, period-heavy.

No content changes. Same chapters, same examples, same migration notes.

Test plan

  • grep -rn '[—–]' book/src/ README.md returns no matches
  • No 'comprehensive' / 'robust' / 'seamless' / 'leverages' / 'facilitates' / 'delve' / 'in essence' tells
  • mdBook builds clean

User flag: docs were leaning AI-generated, which is a turn-off for
operators in 2026. Pass through every chapter to:

* Remove every em-dash (U+2014) and en-dash (U+2013). Bullet-list
  definitions go from "name() -- desc" to "name(). desc."
  Sentence asides go from "X -- Y" to either "X. Y." or "X (Y)".
* Cut hedging adjectives (comprehensive, robust, seamless, etc.).
* Drop section transitions ("Now let's look at...", "Here's...").
* Replace triplet bullet rhythms with prose where the list
  pattern was filler.
* Match the README's voice: terse, opinionated, period-heavy.

No content changes. Same chapters, same examples, same migration
notes. Just voice and punctuation.
@albedosehen albedosehen merged commit 2efba13 into main May 8, 2026
@albedosehen albedosehen deleted the docs/voice-pass branch May 8, 2026 18:21
albedosehen added a commit that referenced this pull request May 9, 2026
The docs workflow had been silently failing at the
actions/configure-pages@v5 step on every push to main since PR #31
introduced it (PRs #31, #32, #34 all red on this leg) because Pages
was never enabled at the repo level. The site at
oneiriq.github.io/rota/ was returning HTTP 404 the whole time despite
the docs PRs claiming it was shipping.

Manually POSTed to /repos/Oneiriq/rota/pages with build_type=workflow
to unblock the current state, and run 25601961989 confirms the
workflow now builds and deploys end-to-end (oneiriq.github.io/rota/
returns 200 with the mdBook content).

Adding enablement: true here as the durable fix so a future fork or a
repo where Pages gets disabled doesn't silently regress to the same
hidden 404 state.
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