Skip to content

Update README documentation #39720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README documentation #39720

wants to merge 2 commits into from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Aug 7, 2025

Why:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

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

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

github-actions bot commented Aug 7, 2025

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
repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 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.

@jsoref
Copy link
Contributor Author

jsoref commented Aug 7, 2025

@Sharra-writes are these links supposed to work?

fpt

This adjective-noun-hash-4000.app.github.dev page can’t be found
No webpage was found for the web address: https://adjective-noun-hash-4000.app.github.dev/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
HTTP ERROR 404

@@ -1,5 +1,6 @@
---
title: About READMEs
title: Repository README file
shortTitle: About READMEs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a hack. @Sharra-writes can fix it more properly at a later date.

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.

Title implies there are multiple relevant README files, but the content relates to a single README.md file per repository
1 participant