Skip to content

Improve documentation English and clarity#19

Merged
meap merged 1 commit intomainfrom
docs/improve-english-guidelines
Aug 17, 2025
Merged

Improve documentation English and clarity#19
meap merged 1 commit intomainfrom
docs/improve-english-guidelines

Conversation

@meap
Copy link
Copy Markdown
Owner

@meap meap commented Aug 17, 2025

Summary

  • Convert passive voice to active voice throughout README.md and aws-authentication.md
  • Break up long sentences (39-52 words) into shorter, clearer ones
  • Remove redundant phrasing and improve pronoun clarity
  • Follow English guidelines for active voice, present tense, and direct instruction style

Key Changes

  • README.md: Fixed ~20 passive voice instances, split long sentences, improved command descriptions
  • aws-authentication.md: Fixed 5 passive voice instances, broke up 42-word sentence, made instructions more direct

Test Plan

  • Verify all technical information remains accurate
  • Confirm examples and commands are unchanged
  • Check that meaning and intent are preserved
  • Ensure consistent tone throughout documentation

Convert passive voice to active voice throughout README.md and aws-authentication.md.
Break up long sentences (39-52 words) into shorter, clearer ones. Remove redundant
phrasing and improve pronoun clarity. Follow English guidelines for active voice,
present tense, and direct instruction style.

Key improvements:
- Convert ~25 passive voice instances to active voice
- Split overly long sentences for better readability
- Use imperative mood for command descriptions
- Maintain technical accuracy while improving clarity
@meap meap merged commit 7a452d0 into main Aug 17, 2025
@meap meap deleted the docs/improve-english-guidelines branch August 17, 2025 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant