Skip to content

feat:On-page table of contents for read-only docs (collection, folder, request) - #23

Open
sachin-bruno wants to merge 8 commits into
usebruno:mainfrom
sachin-bruno:sachin-bruno/table-content
Open

feat:On-page table of contents for read-only docs (collection, folder, request)#23
sachin-bruno wants to merge 8 commits into
usebruno:mainfrom
sachin-bruno:sachin-bruno/table-content

Conversation

@sachin-bruno

@sachin-bruno sachin-bruno commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

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.

image

@sachin-bruno
sachin-bruno marked this pull request as draft July 31, 2026 08:16
@sachin-bruno
sachin-bruno marked this pull request as ready for review July 31, 2026 11:07
Comment thread packages/bruno-api-docs/src/hooks/useDocSections.ts Outdated
Comment thread packages/bruno-api-docs/src/hooks/useDocSections.ts Outdated
Comment thread packages/bruno-api-docs/src/components/SectionNav/SectionNav.tsx Outdated
@sachin-bruno sachin-bruno changed the title feat:Table of content changes for easy navigation feat:On-page table of contents for read-only docs (collection, folder, request) Jul 31, 2026
Comment thread packages/bruno-api-docs/src/components/Section/Section.tsx Outdated
Comment thread packages/bruno-api-docs/src/pages/Request/Request.tsx Outdated

@vasharma05-bruno vasharma05-bruno left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants