Skip to content

docs: state points plainly across the docs site - #627

Merged
mostafa merged 6 commits into
mainfrom
fix/docs-plain-prose
Oct 22, 2026
Merged

mostafa merged 6 commits into
mainfrom
fix/docs-plain-prose

Conversation

@mostafa

@mostafa mostafa commented Oct 22, 2026

Copy link
Copy Markdown
Member

A prose-only editing pass over docs/content, removing phrasing that adds weight without adding information: restating closers, contrasts against claims nobody made, inflated framing ("the lifecycle phase a mature detection program reviews on a cadence"), sales words ("leverages", "for free", "unlocking"), decorative bold, and all-caps emphasis. Slashes that mean "or" are closed up, or turned into a list when they join items.

Code blocks, inline code, flags, config keys, metric names, link targets, headings (and so anchors), and docmd syntax are unchanged. Security wording keeps the same claims.

Three stated counts did not match the lists below them and are corrected: the lint rule buckets (five, not four), the input format test layers (three, not two), and the Helr fallback transports.

guide/enrichers.md still says "five primitives" in its intro and "four primitives" in the recipe and bespoke-enricher sections. stix is the feature-gated fifth primitive and is not a reserved name, so the four may be intentional there; it is left as is.

npm run docs:build and npm run docs:validate pass.

Drop restating closers, contrast phrasing that only adds weight, filler and sales words, and decorative bold, and close up slashes that mean or.
Drop inflated framing, restating closers, decorative bold, and version talk from the command pages, and close up slashes that mean or.
Drop staged openers and change narration, and close up slashes that mean or or turn them into lists. Security claims are unchanged.
…plainly

Remove decorative bold from the rstix page, drop leftover drafting text and arrow chains, and fix a doubled word.
The lint rule bucket table has five rows and the input format test list has three items.
Merge fragment rows into sentences, lowercase all-caps emphasis, fix the LazyVim and AstroNvim names, and match the Helr transport count to its table.
@mostafa
mostafa merged commit 6a331a9 into main Oct 22, 2026
5 checks passed
@mostafa
mostafa deleted the fix/docs-plain-prose branch October 22, 2026 13:27
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