Rewrite docs with Simplified Technical English (ASD-STE100) - #172
Open
kyleve wants to merge 7 commits into
Open
Conversation
Apply STE procedural rules: imperative sentences, max 20 words per instruction, conditions before commands, no semicolons, should→must. Keep all links, commands, paths, code blocks, tables, and factual content. Skipped ./test (Markdown-only). ./sync-agents not run (Ruby unavailable on VM). Co-authored-by: Kyle Van Essen <k@kve.me>
Simplify procedural language: imperative rules, must not should, make sure that not check/ensure, conditions before commands, no semicolons in prose. Preserve structure, links, commands, and facts. Co-authored-by: Kyle Van Essen <k@kve.me>
Apply ASD-STE100 pragmatic mode to all 11 feature AGENTS.md files under Where/ and Ledger/. Rules use imperative voice, conditions before commands, max 20 words per rule, no semicolons, and must instead of should. Links, identifiers, guard test names, code paths, structure, and factual invariants are preserved. Co-authored-by: Kyle Van Essen <k@kve.me>
Apply simple-english skill across all 20 Shared module AGENTS.md files: imperative rules, conditions before commands, no semicolons, must not should. Preserve links, identifiers, guard tests, and factual invariants. Co-authored-by: Kyle Van Essen <k@kve.me>
Apply pragmatic ASD-STE100 across all 40 README files: split long sentences, remove semicolons in prose, replace should with must or delete, remove filler words, keep code blocks/tables/links/identifiers intact. Procedural sections use imperative voice (20-word limit). Descriptive sections use simple present (25-word limit). Co-authored-by: Kyle Van Essen <k@kve.me>
Apply ASD-STE100 pragmatic mode: split long sentences, remove semicolons, replace filler, keep code blocks and tables intact. Co-authored-by: Kyle Van Essen <k@kve.me>
Pin AminBlg/SimpleEnglish at 59bf670 for ASD-STE100 doc rewrites. Co-authored-by: Kyle Van Essen <k@kve.me>
cursor
Bot
force-pushed
the
cursor/simple-english-docs-f320
branch
from
August 9, 2026 05:31
7621754 to
e7b673d
Compare
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
Fresh rewrite against current
main(replaces the stale August branch). Adds the Simple English agent skill and applies pragmatic ASD-STE100 rules across agent docs and READMEs.Scope
AGENTS.md(root + modules)README.md(modules + specs + Ledger)running-tests,github-workflow,todo-triage,building-ui,upgrade-where-backup,tla-verify-protocol)What changed
simple-englishexternal skill — pinned in.agents/external-skills.json; attribution updated.Where/Specifications/.What did not change
Review focus
This is a readability experiment. Spot-check files you know well — root
AGENTS.md, a module pair, and a skill likerunning-tests. Flag any section that feels too terse or loses nuance.Testing
./swiftformat --lint— clean (docs-only)./test— not run (Linux VM; no code changes)