Skip to content

Sidebar Menu #12

@one000mph

Description

@one000mph

Moving this discussion to an issue so it doesn't get lost

Originally started in PR #4

Re: the sidebar menu. It isn't bad right now, but it could probably be better. It would be nice to be able to dynamically expand and collapse the page TOC without navigating to the page. One thing I was just wishing I could have would be the ability to create a top-level TOC/menu item. For example: the CLI Docs and FAQ are both very important pages but don't necessarily belong to another category like Guides or Concepts. There was generically-titled "Documentation" category but that heading feels vague to me. I found the theme file here at this path teleport/docs/theme/toc.html but haven't touched it yet. HTML/CSS isn't my strong suit, so hoping that your design team can help here.

Another issue I noticed just now: when I load a page that is below the fold on in the sidebar menu I lose the view of the TOC outline in the sidebar since the page jumps to the top. One site that has a solution to this is the GCP CLI docs. It looks like there is some sort of event that fires after pageload which updates the scroll anchor in the sidebar (https://cloud.google.com/sdk/gcloud/reference/).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions