docs: remove em dashes, tighten prose, and add the docs home page - #92
Merged
Merged
Conversation
joshua-temple
force-pushed
the
docs/prose-polish
branch
from
June 10, 2026 12:50
34d4ea2 to
85a39c2
Compare
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
force-pushed
the
docs/prose-polish
branch
from
June 10, 2026 13:37
85a39c2 to
c900ba3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Removes every em dash from the project and tightens the documentation prose so it reads like a person wrote it.
— @userto(@user), and the generator emits the same de-dashed comment the committedpromote.yamlcarries.**Term** — textbullet pattern, cut marketing adjectives, and varied sentence structure.docs/index.mdand 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 ./...andgo test ./...green (1019 tests),go vetclean, regeneratedorchestrate.yaml/promote.yamlcontain zero em dashes, andmkdocs build --strictnow produces a rootindex.html.