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

Feature request: In documentation, a section link scrolls the sidebar into view #237

Open
BawdyInkSlinger opened this issue May 25, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@BawdyInkSlinger
Copy link
Contributor

BawdyInkSlinger commented May 25, 2023

Is your feature request related to a problem?
A lot of the times when I am browsing documentation, it'd be easier to find the documentation if I could jump to the current section in the sidebar nav.

But if the sidebar nav isn't showing the current section, there is a moment of disorientation where I'm not sure if I'm looking for a section above or below the current nav.

Describe the solution you'd like.
I'm thinking a link could be added to every documentation section that scrolls the same section in the navbar into view.

Describe alternatives you've considered.
I can live without this but there are times where it would've made finding the section I'm looking for more efficient.

Additional context.
Here is a screenshot to describe this feature visually
image

@BawdyInkSlinger BawdyInkSlinger added the enhancement New feature or request label May 25, 2023
@BawdyInkSlinger
Copy link
Contributor Author

From our conversation here, TME decided the best way to implement this is probably to listen to hashchange events to scroll the sidebar into view. That way no extra links need to be added, the sidebar will always have the right table of contents in when you click on a doc link with a hash, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant