From aa4fcb0008f8b201abbc5c9858f4e773d35cd29e Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Tue, 17 Nov 2020 18:22:27 -0500 Subject: [PATCH 1/3] document the dev-toc --- contributing/development.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/contributing/development.md b/contributing/development.md index 7c6f3b297b1f..cbd0be675d67 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -26,12 +26,19 @@ When you're ready to stop your local server, type CTRLc in Note that `npm run build` is a one-time step that create static assets. + ### Using GitHub Codespaces As an alternative, you can simply use [GitHub Codespaces](https://github.com/features/codespaces). In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser. +### Viewing a top-level TOC + +While running the local server, you can visit [localhost:4000/dev-toc](http://localhost:4000/dev-toc) to view a top-level TOC of all the content in the site. This page is not available on https://docs.github.com. It was created for internal GitHub writers' use. + +At the `/dev-toc` path, you'll see a list of available versions. Click a version, and a list of products will appear. Note that the TOC content is versioned. If you are viewing `free-pro-team@latest` and you click the `Enterprise Admin` product, it will be empty, because there isn't any Admin content available on that version. + ## Site structure This site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.ws/), another Ruby static site generator. From 4a2b39e4780d2a8dbc26beb8c5175041239769bc Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Tue, 17 Nov 2020 18:26:41 -0500 Subject: [PATCH 2/3] remove extra newline --- contributing/development.md | 1 - 1 file changed, 1 deletion(-) diff --git a/contributing/development.md b/contributing/development.md index cbd0be675d67..30014d1bcd37 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -26,7 +26,6 @@ When you're ready to stop your local server, type CTRLc in Note that `npm run build` is a one-time step that create static assets. - ### Using GitHub Codespaces As an alternative, you can simply use [GitHub Codespaces](https://github.com/features/codespaces). From f71fcede1cf2c64d2d9c07b57d4b7e508e1dd62c Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Wed, 18 Nov 2020 15:16:53 -0500 Subject: [PATCH 3/3] Update contributing/development.md Co-authored-by: Janice --- contributing/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/development.md b/contributing/development.md index 30014d1bcd37..9a2c34ed2c09 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -32,7 +32,7 @@ As an alternative, you can simply use [GitHub Codespaces](https://github.com/fea In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser. -### Viewing a top-level TOC +### Viewing a top-level table of contents While running the local server, you can visit [localhost:4000/dev-toc](http://localhost:4000/dev-toc) to view a top-level TOC of all the content in the site. This page is not available on https://docs.github.com. It was created for internal GitHub writers' use.