Skip to content
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

repo sync #1438

Merged
merged 6 commits into from
Nov 18, 2020
Merged

repo sync #1438

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aa4fcb0
document the dev-toc
sarahs Nov 17, 2020
4a2b39e
remove extra newline
sarahs Nov 17, 2020
44240e4
Merge branch 'main' into document-dev-toc
sarahs Nov 18, 2020
f71fced
Update contributing/development.md
sarahs Nov 18, 2020
4897fc7
repo sync
Octomerger Nov 18, 2020
a755205
Merge pull request #16506 from github/document-dev-toc
sarahs Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions contributing/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ 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 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.

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.
Expand Down