Skip to content

Commit aa4fcb0

Browse files
committed
document the dev-toc
1 parent 08880d9 commit aa4fcb0

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

contributing/development.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,19 @@ When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in
2626

2727
Note that `npm run build` is a one-time step that create static assets.
2828

29+
2930
### Using GitHub Codespaces
3031

3132
As an alternative, you can simply use [GitHub Codespaces](https://github.com/features/codespaces).
3233

3334
In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser.
3435

36+
### Viewing a top-level TOC
37+
38+
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.
39+
40+
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.
41+
3542
## Site structure
3643

3744
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.

0 commit comments

Comments
 (0)