Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Docs Website: Existing Table of Contents in markdown documentation #10127

Closed
anoadragon453 opened this issue Jun 4, 2021 · 3 comments · Fixed by #11860
Closed

Docs Website: Existing Table of Contents in markdown documentation #10127

anoadragon453 opened this issue Jun 4, 2021 · 3 comments · Fixed by #11860
Labels
good first issue Good for newcomers T-Other Questions, user support, anything else.

Comments

@anoadragon453
Copy link
Member

When viewing the contributing and installation instructions on the new docs website, one finds that a table of contents exists on the page as well as in the sidebar. These table of contents make sense when viewing the documentation on GitHub, but less so when using the docs website which automatically generate one.

It's worth pointing out that GitHub have also started to generate a table of contents for pages, though the feature currently isn't known to the majority of people:

image

We could certainly add some custom CSS to our mdbook instance to hide table of contents on the website, while simultaneously keeping them on GitHub. But I'm leaning more towards the opinion of just telling people to use the website instead if they want a table of contents to browse the docs with (or point them at GitHub's button).

@anoadragon453 anoadragon453 added T-Other Questions, user support, anything else. X-Needs-Discussion labels Jun 4, 2021
@richvdh
Copy link
Member

richvdh commented Jun 24, 2021

removing the TOCs, and linking to the docs website where possible, sounds good to me.

@richvdh
Copy link
Member

richvdh commented Jul 7, 2021

@anoadragon453 are we agreed that we should just remove the manually-maintained ToCs rather than mess about with magic CSS?

@anoadragon453
Copy link
Member Author

@richvdh yep.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers T-Other Questions, user support, anything else.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants