Skip to content

Commit c3ec112

Browse files
Add instructions for profile README creation
Added instructions for creating a profile README and its placement in the document structure.
1 parent 4ab1a92 commit c3ec112

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,34 @@ You can format text and include emoji, images, and GIFs in your profile README b
4848

4949
{% ifversion fpt %}
5050

51+
# How to create a profile README:
52+
53+
Create a new public repository with a name that exactly matches your username.
54+
55+
Initialize the repository with a README.md file.
56+
57+
Commit and push the README content.
58+
59+
Once created, the contents of the README.md file will be shown at the top of your profile.
60+
61+
Where to add it (important)
62+
63+
Place it here in the document structure:
64+
65+
~~~
66+
Your profile README
67+
├─ (existing intro paragraph)
68+
├─ Creating a profile README repository ← ADD HERE
69+
├─ (examples of what to include)
70+
~~~
71+
This placement matters because:
72+
73+
Readers learn the rule before writing content
74+
75+
It prevents confusion when their README “doesn’t show up”
76+
77+
It aligns with GitHub’s actual detection logic
78+
5179
## Private profiles
5280

5381
To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.github %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity.

0 commit comments

Comments
 (0)