Skip to content

Conversation

@siv-the-programmer
Copy link

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:

  • [x ] 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.
  • [x ] The changes in this PR meet the docs fundamentals that are required for all content.
  • [x ] All CI checks are passing and the changes look good in the review environment.

Added instructions for creating a profile README and its placement in the document structure.
@welcome
Copy link

welcome bot commented Feb 11, 2026

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 11, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

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/concepts/personal-profile.md fpt
ghec
ghes@ 3.19 3.18 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.19 3.18 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.

@siv-the-programmer siv-the-programmer closed this by deleting the head repository Feb 11, 2026
Copy link

@Mainnet7m1 Mainnet7m1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

content/account-and-profile/concepts/personal-profile.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants