docs icon indicating copy to clipboard operation
docs copied to clipboard

Improve profile customization tutorial: fix grammar, enhance intro, a…

Open om-pramod opened this issue 2 months ago • 8 comments

…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.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • [ ] A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • [ ] The changes in this PR meet the docs fundamentals that are required for all content.
  • [ ] All CI checks are passing and the changes look good in the review environment.

om-pramod avatar Oct 12 '25 19:10 om-pramod

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.

welcome[bot] avatar Oct 12 '25 19:10 welcome[bot]

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 links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
account-and-profile/tutorials/personalize-your-profile.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

github-actions[bot] avatar Oct 12 '25 19:10 github-actions[bot]

Hi team! 👋

I would appreciate if a reviewer with write access could review and approve this PR. The changes improve the documentation by:

  • Enhancing the introduction for better clarity and SEO
  • Fixing a grammatical error in the NOTE section
  • Adding accessibility guidance for profile pictures

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 avatar Oct 12 '25 19:10 om-pramod

@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.

Sharra-writes avatar Oct 13 '25 20:10 Sharra-writes

…add 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.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • [ ] A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • [ ] The changes in this PR meet the docs fundamentals that are required for all content.
  • [ ] All CI checks are passing and the changes look good in the review environment.

m74278803-cmyk avatar Oct 14 '25 06:10 m74278803-cmyk

Sci fix

m74278803-cmyk avatar Oct 14 '25 06:10 m74278803-cmyk

Can yiou assign this issue to me?

Talasudeepk avatar Nov 03 '25 08:11 Talasudeepk

A stale label has been added to this pull request because it has been open 30 days with no activity. If you think this pull request should remain open, please add a new comment.

github-actions[bot] avatar Dec 09 '25 16:12 github-actions[bot]