Skip to content

Rewrite common-misconceptions.md per ASD-STE100 - #2031

Closed
elharo wants to merge 2 commits into
masterfrom
rewrite-common-misconceptions-ste100
Closed

elharo wants to merge 2 commits into
masterfrom
rewrite-common-misconceptions-ste100

Conversation

@elharo

@elharo elharo commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Apply Simplified Technical English rules to the common-misconceptions.md documentation:

  • Remove present perfect tense, use simple past/present
  • Remove banned modals (should, may, could, would)
  • Replace semicolons with periods
  • Remove filler words (smooth, considerably, merely)
  • Split long sentences (max 25 words for descriptive text)
  • Use active voice throughout
  • Keep code blocks and identifiers untouched

Changes:

  • 56 insertions, 116 deletions
  • File size reduced from 10,099 bytes to 7,064 bytes
  • All code blocks preserved exactly as original
  • American spelling applied

Apply Simplified Technical English rules:
- Remove present perfect tense, use simple past/present
- Remove banned modals (should, may, could, would)
- Replace semicolons with periods
- Remove filler words (smooth, considerably, merely)
- Split long sentences (max 25 words for descriptive text)
- Use active voice throughout
- Keep code blocks and identifiers untouched
@elharo
elharo marked this pull request as draft August 4, 2026 14:04
@elharo elharo added the documentation Improvements or additions to documentation label Aug 4, 2026
@elharo

elharo commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

try this again when deepseek is up. Big Pickle does not know how to write well. :-(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant