Improve documentation clarity by removing filler words and passive voice #364
Conversation
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
This commit addresses issue #354 by removing unnecessary filler words and converting passive voice to active voice across the Broadway documentation. Key changes across README.md and guide files: - Remove "just" from "you just need to" → "add it as" - Remove "simply" from "simply delegates to" → "delegates to" - Remove "already" from "come already with" → "come with" - Remove "can easily" from "you can easily install" → "install" - Fix comma placement in "First we update" → "First, we update" - Fix "then we print" → "then print" for parallel structure - Fix "However those" → "However, those" (missing comma) - Remove duplicate word "using using" → "using" - Convert "you need to add" → "add it" (more direct) - Convert "You can add" → "Add" (imperative form) These changes make the documentation more direct and concise while maintaining clarity and professionalism, following the guidance from issue #354 and PR #355 feedback. Fixes #354 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Author
|
Closing this PR for now to allow for verification and testing on the forked repository first. Will reopen once changes are validated. |
Author
|
Apologies, accidental AI PR... was trying to test on a fork. |
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.
Summary
This PR addresses issue #354 by making targeted improvements to remove filler words and convert passive voice to active voice across the Broadway documentation.
This is a focused PR that implements specific, non-controversial changes suggested in issue #354, following the feedback from PR #355 to break improvements into smaller, easier-to-review pull requests.
Changes Made
Filler Words Removed:
Passive Voice Converted to Active:
Grammar Improvements:
Files Modified
Testing
mix format --check-formattedRelated Issues
Fixes #354
🤖 Generated with Claude Code