Skip to content

docs: remove em dashes, tighten prose, and add the docs home page - #92

Merged
joshua-temple merged 1 commit into
mainfrom
docs/prose-polish
Jun 10, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/prose-polish

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Removes every em dash from the project and tightens the documentation prose so it reads like a person wrote it.

  • Docs, README, code comments, and generated workflow output no longer contain em dashes. The changelog attribution format moves from — @user to (@user), and the generator emits the same de-dashed comment the committed promote.yaml carries.
  • Reworked the docs and README voice: dropped the stacked **Term** — text bullet pattern, cut marketing adjectives, and varied sentence structure.
  • Adds docs/index.md and wires it into the nav, so the published Pages site has a working landing page. The site previously built without a root page and returned a 404 at the root URL.

Verification: go build ./... and go test ./... green (1019 tests), go vet clean, regenerated orchestrate.yaml/promote.yaml contain zero em dashes, and mkdocs build --strict now produces a root index.html.

Strip every em dash from docs, README, comments, generated output, and the
changelog attribution format, and rework the prose so it reads plainly. Add
docs/index.md so the published site has a working landing page instead of a 404.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit ce3004d into main Jun 10, 2026
8 checks passed
@joshua-temple
joshua-temple deleted the docs/prose-polish branch June 10, 2026 13:54
@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