Rewrite docs with Simplified Technical English (ASD-STE100) - #172
Open
kyleve wants to merge 1 commit into
Open
Conversation
Add the simple-english external skill (AminBlg/SimpleEnglish) and apply pragmatic ASD-STE100 rules across AGENTS.md, README.md, and repo-owned skills: shorter sentences, imperative rules, conditions before commands, consistent terminology. Factual content, links, and identifiers are unchanged. Co-authored-by: Kyle Van Essen <k@kve.me>
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
2 participants
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.
Summary
Adds the Simple English agent skill and rewrites repo documentation using its pragmatic ASD-STE100 rules.
Scope: 30
AGENTS.mdfiles, 29README.mdfiles, and 3 repo-owned skills (running-tests,github-workflow,todo-triage).What changed
simple-englishexternal skill — pinned in.agents/external-skills.json; attribution updated.run,make sure that)What did not change
Net effect
~600 lines removed (1091 insertions, 1697 deletions) — mostly from splitting long sentences and trimming filler, not from dropping content.
How to review
This is an experiment in readability. Spot-check a few files you know well:
AGENTS.md— the contract agents read firstWhere/WhereCore/AGENTS.md+README.mdrunning-testsIf the tone feels too terse or loses nuance anywhere, flag specific sections — easy to tune per-file without reverting the whole pass.
Validation
./swiftformat --lint— clean (docs-only change)./test— not run (Linux VM; no code changes)