Skip to content

Commit 988bf1c

Browse files
Update README documentation (#39720)
Co-authored-by: Sharra-writes <[email protected]>
1 parent 4995a86 commit 988bf1c

File tree

1 file changed

+6
-5
lines changed
  • content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository

1 file changed

+6
-5
lines changed

content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: About READMEs
2+
title: About the repository README file
3+
shortTitle: About READMEs
34
intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.'
45
redirect_from:
56
- /articles/section-links-on-readmes-and-blob-pages
@@ -35,25 +36,25 @@ When your README is viewed on GitHub, any content beyond 500 KiB will be truncat
3536

3637
{% data reusables.profile.profile-readme %}
3738

38-
## Auto-generated table of contents for README files
39+
## Auto-generated table of contents for markdown files
3940

4041
For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.github %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="Table of Contents" %} menu icon at the top left of the rendered page.
4142

4243
![Screenshot of the README for a repository. In the upper-left corner, the "Table of contents" dropdown menu (list icon) is expanded.](/assets/images/help/repository/readme-automatic-toc.png)
4344

44-
## Section links in README files and blob pages
45+
## Section links in markdown files and blob pages
4546

4647
{% data reusables.repositories.section-links %}
4748

4849
For more detailed information about section links, see [Section links](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links).
4950

50-
## Relative links and image paths in README files
51+
## Relative links and image paths in markdown files
5152

5253
{% data reusables.repositories.relative-links %}
5354

5455
## Wikis
5556

56-
A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis).
57+
A README should only contain information necessary for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis).
5758

5859
## Further reading
5960

0 commit comments

Comments
 (0)