docs: rewrite documentation in Simplified Technical English (ASD-STE100) - #323
Draft
lc-kirill wants to merge 1 commit into
Draft
docs: rewrite documentation in Simplified Technical English (ASD-STE100)#323lc-kirill wants to merge 1 commit into
lc-kirill wants to merge 1 commit into
Conversation
Rewrites 350 of the 357 in-scope pages under docs/ into ASD-STE100 Simplified
Technical English. The change is language-only: no fact, permission, version,
limit, default, or platform claim was added, removed, or altered.
What changed in the prose:
- Active voice with a named actor, replacing agentless passives.
- Sentences capped at 25 words (20 for an instruction), one instruction each.
- Prose procedures converted to numbered lists of imperative steps, with
continuation content indented so lists no longer fragment and restart at 1.
- Simple tenses only; gerund subjects rewritten as clauses.
- Articles restored; noun clusters over three words broken up.
- Warnings and cautions lead with the command, then the reason.
- Approved-word substitutions (utilize -> use, via -> with/through,
ensure -> make sure, prior to -> before, follow -> obey, and similar).
- Marketing vocabulary and idiom removed ("for the modern era",
"best-of-breed", "seamlessly", "out of the box", "spin up", "heavy lifting").
- One term per concept per the terminology table in the new style guide.
Deliberately frozen, and mechanically verified byte-identical:
- Every heading. 527 anchor links target them and mkdocs.yml mirrors them as
nav labels, so rewording headings would break links for little gain.
- Every fenced code block, inline code span, link and image target, snippet
include, abbreviation definition, admonition/tab marker, and table shape.
Not rewritten: seven link-index stubs of 19-89 words that were already
compliant, plus three generated files (includes/glossary.md,
10-release-notes/index.md, assets/images/README.md).
scripts/list-numbering-baseline.json is regenerated. The same five
pre-existing numbering breaks remain; two had their surrounding text reworded,
so the baseline keys no longer matched.
simplified-technical-english.md documents the rules applied, so the standard is
reviewable and repeatable.
Verified: mkdocs build --strict exits 0; markdownlint-cli2 reports 0 issues;
check-list-numbering.py reports 0 new breaks.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Rewrites 350 of the 357 in-scope pages under
docs/into ASD-STE100 Simplified Technical English.This is a language-only change. No fact, permission, version, limit, default, or platform claim was added, removed, or altered. Where a page said something wrong, it still says it — those cases are listed as follow-ups rather than silently fixed.
What changed in the prose
utilize→use,via→with/through,ensure→make sure,prior to→before,follow→obey, and similar.What is deliberately frozen
Verified mechanically byte-identical against
masterfor all 350 files:mkdocs.ymlmirrors them as nav labels, so rewording headings would break links across the site for very little gain. This is the main scope limit of the PR.--8<--), abbreviation definition, admonition/tab marker, and table shape.Not rewritten
Seven link-index stubs of 19–89 words that were already compliant (
2-sensors-deployment/index.md,8-reference/faq/index.md, and five similar), plus three generated files:includes/glossary.md,10-release-notes/index.md,assets/images/README.md.Verification
mkdocs build --strictmarkdownlint-cli2scripts/check-list-numbering.pymaster(headings, code, links, tables)Nine lint regressions appeared mid-work and are fixed in this branch: ordered-list renumbering in
endpoint-agent/windows/custom-msi.md, and emphasis-as-heading inlookup-manager.md/yara-manager.md.Two things reviewers should know
1.
scripts/list-numbering-baseline.jsonis regenerated. The same five pre-existing numbering breaks remain — none are new. Two of them had their surrounding prose reworded, so the old baseline keys (which embed a text prefix) no longer matched and CI would have reported them as new.2. A pre-existing rendering bug is left in place. In
2-sensors-deployment/endpoint-agent/windows/installation.md, a PowerShell block is closed with```pythoninstead of```. A closing fence may not carry an info string, so the fence never closes and the whole "LimaCharlie Web Application", "Troubleshooting", and "Uninstallation" content currently renders inside a code block. The Uninstallation section repeats the pattern. I rewrote that prose but left the markup alone, because fixing it changes rendering structure rather than language. It is the one file the structural check still flags, and it deserves its own PR.Follow-ups found but not actioned
The rewrite surfaced roughly 150 pre-existing defects — invalid JSON/YAML in samples, orphaned admonitions that lost their
!!!markers, contradictory platform and response-event columns in8-reference/endpoint-commands.md, SDK import paths that do not match the publicpython-limacharliepackage, and severaldetection and response ()empty-parenthesis artifacts. The full triaged list is held outside this public repo at~/ste-rewrite-findings.md, because one entry concerns internal infrastructure identifiers that appear in a currently-published page and should not be restated here. Ask me for that item directly.simplified-technical-english.mdis added at the repo root, alongside the existingmarkdown-lint.mdcontributor doc, so the standard applied here is reviewable and repeatable. Drop it if you would rather not carry it.🤖 Generated with Claude Code