docs: STE pass over the user guide — minimize em dashes, active voice, short words - #167
Merged
Conversation
…, short words Simplified Technical English (kubehz house profile, FLAVORED mode) rewrite of all docs/guide/*.md plus docs/reference/cli.md. Form pass only: no fact, flag, number, or caveat dropped. Em dashes cut from 609 to 68 (the rest sit in code blocks, CLI output, headings, container titles, and link text, which this pass does not touch). Passive constructions moved to active voice where the actor is known; banned words (provide, ensure, obtain, ...) replaced; long dash-spliced sentences split. Headings and link targets unchanged so no anchors break. ste-lint per100w dropped (or stayed equal) on every file; vitepress build clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MoNRvwDrEPJeGGgQtLHxqv
… en dash, Robot term Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MoNRvwDrEPJeGGgQtLHxqv
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.
STE (Simplified Technical English) rewrite pass over every user-facing doc: all of
docs/guide/*.mdplusdocs/reference/cli.md. kubehz house profile, FLAVORED mode, with the updated em-dash policy as the main focus.This is a form pass, not a content edit. Every fact, flag, number, version, and caveat is preserved. Headings, link targets, code blocks, frontmatter, and VitePress container syntax are untouched.
What changed
provide→ give/serve/pass, plus the rest of the banned list where it appeared in prose.—placeholders for "empty" became(none)(index.md profiles table, kubehz.md--node-ipdefault, toolchain.md profiles table) — no information lost.Lint scores (ste-lint.py, flavored mode)
Both
per100wandem_dashdropped (or stayed equal) on every file:Deliberately left in place
The 68 remaining em/en dashes are all in positions the hard guards protect:
## Hooks — re-run a Job or restart on edit,### envoy-gateway — upgrading in place,### sso-gate — OIDC login in front of any service,## Addons vs targets vs inline — where does it go?,### One cluster per plane — NOT per subdomain or service,### Plane A/B — …,## What is stored — and what never is,## Preserving the client IP — PROXY protocol,### Where it's configured — the driver, not a cluster resource,### Common case — resolve a zone to the gateway LB,# Local AI — lo chat, plus the1–3en-dash range in a services.md heading.:::declaration line):::: danger BREAKING CHANGE — migrate before your next lo up,::: tip Generated post-install — preview it,::: warning BREAKING CHANGE — existing KubeOne clusters.lo auditFAIL output, thelo recoverDONE in XmYs — phases: …summary, the components mutual-exclusion error string, the doctor advice string in bare-metal.md (quoted tool output; rewording would misquote what the tool prints).[Specs reference — Provider],[CLI reference — Remote clusters],[Specs — Provider and remote mode],[Specs reference — Registries Configuration], and the#plane-b-—-workloads-targetsanchor in services.md.No heading violates STE badly enough to flag beyond the dashes listed above.
Verification
python3 ste-lint.pybefore/after on every file (table above); a mid-pass regression on local-dev.md (self-introduced semicolons) was caught and fixed before commit../node_modules/.bin/vitepress build docspasses clean (client + server bundles, page render, sitemap).Do not merge without review — per house policy this PR should go through the review loop first.
🤖 Generated with Claude Code
https://claude.ai/code/session_01MoNRvwDrEPJeGGgQtLHxqv