-
Notifications
You must be signed in to change notification settings - Fork 63.8k
Improve profile customization tutorial: fix grammar, enhance intro, a… #40826
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…dd accessibility guidance This PR enhances the profile personalization tutorial with three key improvements: 1. **Enhanced intro section**: Expanded the intro description to be more comprehensive and SEO-friendly, providing clearer context about what users will learn. 2. **Grammar correction**: Fixed grammatical error in the NOTE section (line 77) from "Your profile name for your is {% data variables.product.github %} account" to "Your profile name for your {% data variables.product.github %} account". 3. **Accessibility guidance**: Added a new TIP callout in the profile picture section recommending users choose images with good contrast and clear visibility at small sizes. This helps users understand best practices for profile picture selection, improving overall user experience and accessibility. These changes improve documentation clarity, correctness, and user guidance while maintaining consistency with GitHub Docs style.
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These thoughtful changes improve clarity, correctness, and user guidance in the documentation, making your contribution both meaningful and impactful. The PR title and description clearly communicate the enhancements and their value for GitHub users and maintainers.
Hi team! 👋 I would appreciate if a reviewer with write access could review and approve this PR. The changes improve the documentation by:
All checks have passed successfully. I'm happy to address any feedback or make additional changes if needed. Thank you for your time and consideration! 🙏 |
@om-pramod Thanks for opening a PR! Unfortunately, per our CONTRIBUTING.md, we aren't currently taking edits that purely affect tone, readability, or efficiency. We're getting spammed with AI edits, and AI is just not very good at editing. It's less precise, takes longer to say the same thing, and often over-explains, so we've decided not to spend time reviewing PRs that don't correct a mistake in an existing article or expand on important topics overlooked in our documentation. I do notice you've corrected a typo in this article, and if you would like to revise the PR to make only that change, we would be happy to accept that correction. |
…dd accessibility guidance
This PR enhances the profile personalization tutorial with three key improvements:
Enhanced intro section: Expanded the intro description to be more comprehensive and SEO-friendly, providing clearer context about what users will learn.
Grammar correction: Fixed grammatical error in the NOTE section (line 77) from "Your profile name for your is {% data variables.product.github %} account" to "Your profile name for your {% data variables.product.github %} account".
Accessibility guidance: Added a new TIP callout in the profile picture section recommending users choose images with good contrast and clear visibility at small sizes. This helps users understand best practices for profile picture selection, improving overall user experience and accessibility.
These changes improve documentation clarity, correctness, and user guidance while maintaining consistency with GitHub Docs style.
Why:
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following: