Improve clarity and consistency in README for GitHub Docs repository #34796
Conversation
This file contains 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 update enhances the clarity and readability of the README for the GitHub Docs repository by refining the structure and wording of the document. Key changes include: - Improved sentence flow and consistency for easier understanding. - Consolidated contribution instructions and simplified navigation guidance. - Enhanced descriptions for contributing, including local setup, opening issues, and making contributions via Codespaces. - Ensured the use of appropriate alt text for images and consistent formatting across sections. - Updated licensing and support details for better accuracy. These changes aim to maintain the professional tone and ensure the content remains clear and accessible for contributors.
This update enhances the clarity and readability of the README for the GitHub Docs repository by refining the structure and wording of the document. Key changes include: - Improved sentence flow and consistency for easier understanding. - Consolidated contribution instructions and simplified navigation guidance. - Enhanced descriptions for contributing, including local setup, opening issues, and making contributions via Codespaces. - Ensured the use of appropriate alt text for images and consistent formatting across sections. - Updated licensing and support details for better accuracy. These changes aim to maintain the professional tone and ensure the content remains clear and accessible for contributors.
github-actions
bot
added
the
triage
nguyenalex836
added
content
|
@kiruthikpurpose Thank you for submitting a PR! Unfortunately since these changes are mainly personal preferences on how to phrase something, rather than corrections or improvements, we won't be able to accept this contribution 💛 If you'd like to make changes I'd recommend raising an improvement issue here, then someone from the team can take a look at your proposal before you submit your PR ✨ Check out https://docs.github.com/en/contributing for more information about contributing, and our house style. |
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.
This update enhances the clarity and readability of the README for the GitHub Docs repository by refining the structure and wording of the document. Key changes include:
These changes aim to maintain the professional tone and ensure the content remains clear and accessible for contributors.