Skip to content

Request: TOC for doc pages #3077

Closed

Description

@nynexman4464

The CLI doc is hard to navigate. I wish it had a table of contents or something so I could scroll to the command I'm interested in.

https://astryx.atmeta.com/docs/cli

Activity

  1. changed the title [-]Request: TOC for cli page[/-] [+]Request: TOC for doc pages[/+] on Jun 24, 2026
  2. nynexman4464 commented on Jun 24, 2026

    @nynexman4464
    ContributorAuthor

    Actually I'd like to see this for all the doc pages - https://astryx.atmeta.com/docs/styling for example could benefit from this also. #3081 is also probably required to do this (EG linkable sections)

  3. cixzhang commented on Jun 24, 2026

    @cixzhang
    Contributor

    @ernestt was working on adding Outline to some of these pages. Maybe we can extend it to the Markdown ones that are derived from our README files.

  4. ernestt commented on Jun 25, 2026

    @ernestt
    Contributor

    Addressed in #3101.

    Documentation pages now render an "On this page" table of contents — a sticky outline on desktop and a "jump to section" selector on mobile — including the CLI/library README pages. Section headings also got stable ids so the TOC entries deep-link correctly.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions