jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Scannability: Codespaces introductory content (#54688)

Browse Source 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
Ben Ahmady
2025-03-11 12:14:17 +00:00
committed by GitHub
parent cba2b19d71
commit 1aea5879b0
31 changed files with 112 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md
View File

@@ -12,7 +12,7 @@ versions:
{% data variables.product.prodname_github_codespaces %} allows you to work in a development environment that's hosted remotely from your machine. You can get started quickly, without needing to set up the working environment or download files to your local computer.
For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/overview).
For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/quickstart).
## Working on documentation in a codespace
@@ -26,7 +26,7 @@ The following steps assume you have {% data variables.product.prodname_github_co
The "Setting up your codespace" page is displayed. After a short time the browser-based version of {% data variables.product.prodname_vscode %} is displayed.
1. Use the Explorer to navigate to the markdown file you want to edit. If the file is an article, it will be located in the `content` directory. If the file is reusable content, it will be located in the `data` directory.
In most cases, the path to an article in the `content` directory matches the path in the URL, minus the `.md` file extension. For example, the source for the article `https://docs.github.com/en/codespaces/getting-started/quickstart` is the markdown file `content/codespaces/getting-started/quickstart.md`.<!-- markdownlint-disable-line search-replace -->
In most cases, the path to an article in the `content` directory matches the path in the URL, minus the `.md` file extension. For example, the source for the article `https://docs.github.com/en/codespaces/quickstart` is the markdown file `content/codespaces/quickstart.md`.<!-- markdownlint-disable-line search-replace -->
1. Edit the markdown file as required.
1. Save your changes.
1. Commit and push your changes, either using the Source Control view, or using Git commands from the Terminal. For more information, see [AUTOTITLE](/get-started/using-git/about-git).