feat:On-page table of contents for read-only docs (collection, folder, request) - #23
Open
sachin-bruno wants to merge 8 commits into
Open
feat:On-page table of contents for read-only docs (collection, folder, request)#23sachin-bruno wants to merge 8 commits into
sachin-bruno wants to merge 8 commits into
Conversation
sachin-bruno
marked this pull request as draft
July 31, 2026 08:16
sachin-bruno
marked this pull request as ready for review
July 31, 2026 11:07
arpit-bruno
requested changes
Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ref: BRU-4087
Problem
Rendered API-docs pages get long: a single request stacks Params, Body, Headers, Auth, Execution Context (with its own tabs), a code snippet, and free-form markdown, while overview and folder pages add arbitrarily long documentation on top. There was no way to see a page's structure at a glance, jump straight to a section, or tell where you are while scrolling — readers had to scroll and hunt, and the docs lacked the "on this page" outline that almost every documentation site provides.
Fix
Adds a SectionNav "on this page" navigator: a fixed right-edge rail of tick marks (a mini-map of the page) that expands on hover/focus into a labelled table-of-contents popup, with scroll-spy that highlights the section you're currently reading. Pages declare their own outline through DOM markers (data-nav-section / data-nav-headings), so the navigator stays in sync with whatever each page renders — including markdown h1–h6 as nested entries — rather than hardcoding a structure per page.