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

nav: create title entry in right CONTENTS ToC sidebar #37

Open
jorgeorpinel opened this issue Oct 22, 2019 · 5 comments
Open

nav: create title entry in right CONTENTS ToC sidebar #37

jorgeorpinel opened this issue Oct 22, 2019 · 5 comments

Comments

@jorgeorpinel
Copy link

jorgeorpinel commented Oct 22, 2019

Often there's a long intro in our docs before getting to the first H2 header (example below) but the CONTENTS navigation element in the right side bar does not list the document's H1 title, so it's not possible to scroll to the very top (in order to read the intro) from there, which I think would be a logical feature.

image

https://dvc.org/doc/tutorials/versioning

@jorgeorpinel jorgeorpinel added type: enhancement good first issue Good for newcomers A: docs Area: documentation website: eng-doc and removed good first issue Good for newcomers labels Oct 22, 2019
@jorgeorpinel jorgeorpinel changed the title engine: create title entry in CONTENTS nac (right side bar) engine: create title entry in CONTENTS nav (right side bar) Oct 28, 2019
@jorgeorpinel jorgeorpinel changed the title engine: create title entry in CONTENTS nav (right side bar) docs: create title entry in CONTENTS ToC (right side bar) Jan 5, 2020
@jorgeorpinel jorgeorpinel changed the title docs: create title entry in CONTENTS ToC (right side bar) nav: create title entry in right CONTENTS ToC sidebar Jan 19, 2020
@jorgeorpinel jorgeorpinel removed the A: docs Area: documentation label Jan 19, 2020
@jorgeorpinel
Copy link
Author

jorgeorpinel commented Jan 8, 2021

I keep bumping into this issue. WDYT @shcheklein / @rogermparent, worth prioritizing soonish?

@rogermparent
Copy link
Contributor

rogermparent commented Jan 8, 2021

Seems simple enough, but we may want to consider a design other than simply adding the top heading to the content bar. There is an issue we must solve in how to handle pages that hide the content menu, i.e. pages with no headings besides the top h1.

For example, we could add a "Return to Top" button like in many other blogs; it could be located next to the "content" heading when the list is present, and maybe show standalone when on a page without subheadings.

@shcheklein

This comment was marked as outdated.

@jorgeorpinel

This comment was marked as outdated.

@jorgeorpinel
Copy link
Author

Note that I've been using a workaround in the docs repos (example). We should remove these if the feature gets implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants