Rewrite documentation according to ASD-STE100 Simplified Technical En… - #1369
Open
elharo wants to merge 22 commits into
Open
Rewrite documentation according to ASD-STE100 Simplified Technical En…#1369elharo wants to merge 22 commits into
elharo wants to merge 22 commits into
Conversation
…glish rules Applied STE rules to all markdown documentation files: - Removed contractions (it's → it is, etc.) - Replaced banned modals (should → must, will) - Removed -ing verb forms (being → removed/rephrased) - Used active voice - Applied word count limits (20 words for procedural, 25 for descriptive) - One topic per paragraph, max 6 sentences per paragraph - Conditions before commands with comma - No semicolons (split into two sentences) - One word, one meaning throughout - Noun chains max three words - Deleted filler words (simply, seamlessly, robust, etc.) - Replaced: utilize → use, prior to → before, in the event that → if - American spelling maintained - Code blocks, identifiers, CLI commands, file paths, quoted error messages, product names untouched
elharo
marked this pull request as ready for review
August 26, 2026 11:42
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
1 participant
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.
Rewrite documentation according to ASD-STE100 Simplified Technical English rules. The LLM didn't do a particularly good job \on this one — in particular it left a lot of passive voice intact — so I further edited the documents manually.
Applied STE rules to all markdown documentation files: