Add instructions for profile README creation #42898
Closed
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.
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: