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.

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

Improve double table of contents #1425

Closed
hiimbex opened this issue Nov 18, 2020 · 2 comments
Closed

Improve double table of contents #1425

hiimbex opened this issue Nov 18, 2020 · 2 comments
Labels
engineering Will involve Docs Engineering triage Do not begin working on this issue until triaged by the team

Comments

@hiimbex
Copy link

hiimbex commented Nov 18, 2020

What is the current behavior?

https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#contents is a particularly potent example, but this applies to https://docs.github.com/en/free-pro-team@latest/rest/reference/* as well

What changes are you suggesting?

Right not there's this weird thing with the table of contents being on the left and the sub-table of contents being on the right, but the right hand portion does not scroll with where you are on the page.

I'd prefer to have a single pane of navigation rather than left and right table of contents; however, at a minimum I'd expect the right hand portion to be able to keep up with where I am scrolled on the page

@hiimbex hiimbex added the engineering Will involve Docs Engineering label Nov 18, 2020
@welcome
Copy link

welcome bot commented Nov 18, 2020

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 18, 2020
@simpsoka
Copy link
Contributor

Thanks for opening this @hiimbex! The left sidebar is the main navigation for the site, and it's contextual to the page (or section of docs) that you're reading about. I know it might be confusing, but it's not actually a table of contents for the page you're reading. For this reason, and others, we're actually re-vamping the navigation and will be deprecating the sidebar navigation for a top of page navigation that's more traditional. I don't have an issue open for this yet, but we can add one when we get closer to that project - but I believe this change will eliminate the confusion between the two navigational systems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Will involve Docs Engineering triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

No branches or pull requests

2 participants