Skip to content

docs: one Docs menu and Catalog in the top bar - #6860

Merged
ukimsanov merged 1 commit into
mainfrom
docs/navbar-simplify
Oct 30, 2026
Merged

ukimsanov merged 1 commit into
mainfrom
docs/navbar-simplify

Conversation

@ukimsanov

@ukimsanov ukimsanov commented Oct 30, 2026 •

Copy link
Copy Markdown
Collaborator

What

A simpler docs top bar: 11 items become 7.

Logo · Docs ▾ · Catalog · Search · ★ GitHub · Download · theme toggle

  • One "Docs" menu holds Make a video, Studio app and Developers. Each keeps its own sidebar, as before.
  • Below them in the same menu: Free lessons, Community and the app changelog. These used to be a "Lessons" link or weren't in the bar.
  • Catalog stays a tab.
  • Removed from the bar: the Lessons link (now in the menu) and the desktop top-bar Ask Assistant button.
  • The logo opens the homepage (hyperframes.heygen.com/) instead of /introduction.
  • The button reads "Download" instead of "Download Studio". Its link and src=docs-navbar tag don't change.
  • Search, GitHub stars and the theme toggle stay.

Screenshots of this version and the six others we compared: https://www.heygenverse.com/a/c767dc23-0a9c-481d-90b6-3e9d33da97ff

Why

James asked to simplify the bar and to choose top-level items by clicks. Mintlify already sends every top-bar click to PostHog (project 356858). Click rates for 10,018 desktop docs visitors, 28–29 Oct:

Item Clicked by Change
Make a video, Studio app, Developers tabs 6.3%, 6.3%, 4.5% Move into Docs ▾
Catalog tab 5.1% Stays
Logo 6.0% Now opens the homepage. It used to open the same page as the first tab: 190 people clicked it while already on that page.
Download button 5.0%; 690 downloads in 2 days vs 107 from the quickstart and footer together Stays, with a shorter label
GitHub stars 2.7% Stays
Search 1.7% Stays
Theme toggle 1.2% Stays. Mintlify has no other place for it.
Lessons 1.0% Moves into Docs ▾
Ask Assistant button 0.8% Hidden. Ask is still in the ⌘K search window and in the "Ask a question" bar at the foot of every page (checked on 6 page types on the live site, including /catalog). ⌘I still opens it.

The trade-off. 13% of visitors (1,309) clicked a tab; 12% clicked one of the three tabs that move. Reaching those three now takes two clicks instead of one. In return:

  • the bar uses the homepage's words (Catalog · Docs);
  • the Download button has 6 neighbours instead of 10;
  • the space after Catalog is free for what comes next, such as a launch or a language switcher.

Related work

Refs the request in #hyperframes-squad-internal (30 Oct). Follows #6588, which added the Lessons link.

How

  • docs.json:

    • logo.href set to the homepage;
    • Lessons removed from navbar.links;
    • navbar.primary.label changed to "Download";
    • the Make a video, Studio app and Developers tabs become items of one Docs tab menu, with their groups unchanged, plus three full-URL href items. Catalog stays a tab after it.

    The diff looks big only because the moved groups are indented one level deeper; git diff -w shows the real change. The same 583 pages are listed, none added or lost (checked with a script). The one order change: Catalog's pages now come after Developers. Menu items with relative hrefs rendered as href="/" in mint dev, so Examples, Help and What's new stay in the sidebar.

  • custom.css:

    • The existing rule that hid #assistant-entry at 1024–1199px now covers every desktop width. Its comment says it targets Mintlify's markup, so re-check it after Mintlify updates. Phones keep their own Ask entry.
    • Menu titles use --hf-heading; in dark mode they were the same grey as their descriptions.
    • The rule that lines the logo up with the sidebar text matched the logo by its /introduction link. It now matches the logo image, so the new link doesn't knock the logo 16px out of line.

Test plan

  • mint validate and mint broken-links --check-redirects pass locally on the branch rebased onto main (the two Mint steps in docs.yml).
  • Ran mint dev and checked in Chrome at 1440px, light and dark:
    • the bar shows Logo · Docs ▾ · Catalog · Search · ★ · Download · theme toggle;
    • all 6 menu items fit without scrolling;
    • Make a video → /introduction, Studio app → /studio-app, Developers → /developers/overview;
    • the three outside links open in a new tab;
    • each section shows only its own sidebar, as the tabs did (/studio-app, /catalog, /developers/overview);
    • from /catalog, Docs ▾ → Studio app lands on /studio-app.
    • the logo lines up with the sidebar text at 36px, as on the live site.
  • At 390px: the bar is unchanged (logo, search, menu). The phone menu now opens with two pickers: Docs, then the section.
  • Live site: the bottom "Ask a question" bar shows on /introduction, /catalog, a catalog block, /developers/overview, /studio-app and /examples.
  • On this PR's preview (hyperframes-docs-navbar-simplify.mintlify.site): the top-bar Ask button is in the page but hidden at 1280 and 1440, the bottom "Ask a question" bar shows, and ⌘I opens the Assistant panel.
  • After merge, comparing the same weekdays 7 days before and after:
    • Download clicks per 1,000 desktop docs visitors (69 today) stay at or above 65;
    • visits to Studio app and Developers pages that start from another docs page don't fall by more than 10%;
    • menu-item clicks appear in PostHog autocapture.
  • Comments say why, not what.

Make a video, Studio app and Developers move into a Docs menu (each keeps its
own sidebar), with Free lessons, Community and the app changelog under them;
Catalog stays a tab. The top-bar copy of Ask Assistant goes (Ask stays in
search and the page's bottom bar); the logo opens the homepage; the button
reads Download.
@mintlify

mintlify Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 30, 2026, 8:05 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI balanced review requested due to automatic review settings October 30, 2026 19:59

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed at 611e65c284b22046882d2e7d6ef6a0ef233e06b0.

I found no blocking issue. I compared the whitespace-insensitive diff and recursively counted navigation pages: base and head each contain the same 583 entries, including multiplicities. All four original sections retain byte-equivalent parsed groups; the existing download destination and src=docs-navbar remain unchanged. The Assistant removal is limited to the desktop header; its other entry points are untouched.

Need: yes · Size: ok · Reuse: Mintlify's existing tab/menu navigation · Simpler: already minimal · Structure: fine
Risk: low — navigation regrouping and scoped CSS, with no page removal.

I checked the complete configuration and CSS. mint validate on the stacked tree did not finish within a two-minute local run and was stopped; I am not claiming a Mint build or broken-links pass. I have not independently exercised the hydrated Docs dropdown, phone pickers, or Assistant keyboard shortcut. There are no substantive prior reviews to resolve; Copilot's comment reports exhausted review quota.

Verdict: COMMENT, code clear.
Reasoning: The navigation contract is preserved. I need James's authorization before posting an approval on this request.

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed at 611e65c284b22046882d2e7d6ef6a0ef233e06b0, unchanged since my code-clear review. James authorized the approval in the review thread.

I found no blockers. My earlier recursive comparison verified the same 583 navigation entries and identical groups in all four sections. The download address and source tag are preserved. No new tests were run for this unchanged head; the earlier local Mint validation timed out, and I have not independently walked the hydrated menus.

Need: yes · Size: ok · Reuse: existing Mintlify menu and section groups · Simpler: already minimal · Structure: fine
Risk: low — navigation regrouping and scoped CSS without removing pages.

Verdict: APPROVE
Reasoning: The navigation contract is preserved, and the head has not changed since the substantive review.

@ukimsanov
ukimsanov added this pull request to the merge queue Oct 30, 2026
Merged via the queue into main with commit 4cee7be Oct 30, 2026
111 checks passed
@ukimsanov
ukimsanov deleted the docs/navbar-simplify branch October 30, 2026 21:19
@heygengenesis heygengenesis Bot mentioned this pull request Oct 31, 2026

This branch was successfully deployed

1 active deployment
staging - docs — 611e65c2 Deployed Oct 30, 2026 by mintlify[bot]
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