docs: Improve README wording and consistency#12
Open
GarimaDixit2502 wants to merge 4 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Documentation-only PR that cleans up README wording and formatting to improve clarity and consistency for users.
Changes:
- Normalized punctuation/wording across the intro and “How It Works” sections.
- Clarified some option descriptions (org scoping, sorting detail, PAT wording).
- Minor Markdown formatting tweaks (indentation, spacing).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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 improves the clarity, grammar, and consistency of the README documentation. The changes are purely textual and do not affect any functionality, commands, or project behavior.
Changes Made
Rationale
These updates aim to enhance the readability and professional quality of the documentation while ensuring all technical details, commands, and links remain unchanged.
Impact
Verification