Add instructions for profile README creation#42898
Add instructions for profile README creation#42898siv-the-programmer wants to merge 2 commits intogithub:mainfrom
Conversation
Added instructions for creating a profile README and its placement in the document structure.
|
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. |
Mainnet7m1
left a comment
There was a problem hiding this comment.
content/account-and-profile/concepts/personal-profile.md
Added instructions for creating a profile README and clarified where it appears in the document structure.
Why:
Closes: (no existing issue)
The current documentation explains what a profile README is, but does not mention the required condition that the repository name must exactly match the user’s GitHub username for the README to appear on the profile.
This omission commonly causes confusion for new users whose README does not render as expected. Documenting this requirement makes the setup process explicit and prevents failed configurations.
What's being changed:
Added a new subsection under “Your profile README” explaining that:
A profile README is only displayed when it exists in a public repository named exactly after the user’s username
GitHub automatically detects this repository and renders its README.md on the profile
README files in repositories with any other name will not appear on the profile
Included brief, step-by-step instructions for creating the correct repository
Placed the new content immediately after the introductory paragraph of the “Your profile README” section so users learn the requirement before writing content
This change documents existing behavior only and does not modify functionality.
Check off the following: