Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
This repository was 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

Description

@anoadragon453

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    T-OtherQuestions, user support, anything else.good first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions