docs: fix a repo param on codespaces url #39540

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.

Sign up for GitHub

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

Jump to bottom

Closed

JamBalaya56562 wants to merge 1 commit into github:main from JamBalaya56562:codespaces

+1 −1

Contributor

JamBalaya56562 commented Jul 27, 2025

Summary:

Documentation:

Fix the repo parameter in the Codespaces URL in README.md to reference github/docs

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

Before	After
https://github.com/codespaces/new/?repo=github	https://github.com/codespaces/new/?repo=github/docs

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.


          docs: fix a repo param on codespaces url

f6382b1

github-actions bot added the triage label

Contributor

github-actions bot commented Jul 27, 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.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

Contributor

Sharra-writes commented Jul 28, 2025 •

edited

Loading

@JamBalaya56562 I really need to prioritize changing the readme. The reason the link points to github and not docs is because the README.md is meant for internal use, and people at GitHub may need spin up a codespace on any one of our internal repositories. It's why we have a separate contributing doc that we link open source contributors to. Because docs syncs with docs-internal, all the files have to be exactly the same, even those we keep in docs-internal for internal use.

I need to make it clearer the readme is for internal use, I just haven't been prioritizing it, but you're the third person in 2 weeks who has wanted to fix it to make it better for open source contributors. 😅 I'm going to close this PR, but thank you for opening it. 💛 That file is legitimately confusing and needs to be fixed, just not in this way.

Sharra-writes closed this

JamBalaya56562 deleted the codespaces branch

July 28, 2025 23:37

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

Labels

triage