Skip to content

Compact mobile chrome for the docs pages - #1357

Merged
tmashara merged 8 commits into
masterfrom
docs-mobile-header-prototype
Oct 6, 2026
Merged

tmashara merged 8 commits into
masterfrom
docs-mobile-header-prototype

Conversation

@tmashara

@tmashara tmashara commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Prototype for the #website-design thread

website PR

changes

  • hides the main navbar on page scroll for mobile devices
  • moves on this page to a dropdown control in the secondary topbar on mobile devices
  • search is just an icon now for mobile devices
  • moves breadcrumbs to the page content for mobile devices
  • a chevron in the left sidebar nav now expands/collapses a menu item with child items

preview https://docs-pr-1357-metaboat.vercel.app/docs/latest/

docs.mov

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

The deployments were removed when this pull request closed. Reopening it deploys again at the same address.

@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch 2 times, most recently from 5196eba to 39d90e4 Compare September 28, 2026 11:47
@tmashara tmashara changed the title Compact mobile chrome for the docs shell Compact mobile chrome for the docs pages Sep 28, 2026
@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch 4 times, most recently from 92aa795 to d104f2b Compare September 29, 2026 11:42
@tmashara
tmashara marked this pull request as ready for review September 29, 2026 11:48
@tmashara
tmashara requested a review from a team September 29, 2026 11:48
Comment thread .stylelintrc
"plugins": ["stylelint-order"],
"rules": {
"alpha-value-notation": "number",
"length-zero-no-unit": [true, { "ignore": ["custom-properties"] }],

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

to allow --section-bar-top: 0px

@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch 2 times, most recently from 897f7e6 to dc90eb3 Compare September 29, 2026 12:41
@tmashara
tmashara marked this pull request as draft September 29, 2026 13:32
@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch from dc90eb3 to 8928cbc Compare September 29, 2026 13:35
@tmashara
tmashara marked this pull request as ready for review September 29, 2026 13:49
@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch from 8928cbc to 11a093e Compare September 29, 2026 16:15
@losrebellos
losrebellos requested a balanced review from Copilot October 5, 2026 09:13

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 review overview

🟡 Changes recommended

The mobile TOC has keyboard-focus and empty-state regressions that should be resolved before approval.

Review effort: Balanced
Findings: 2 Medium severity

Open (2)
What changed in this PR

Introduces compact, scroll-aware mobile navigation for documentation pages.

Changes:

  • Adds collapsible mobile headers, side navigation, and “On this page” dropdown.
  • Moves mobile breadcrumbs and simplifies search.
  • Refactors header controls and related legacy assets.
File Description
.stylelintrc Allows units on zero-valued custom properties.
public/​docs/​css/​inkeep.css Styles mobile search as an icon.
public/​docs/​js/​learn/​left-sidebar.js Removes legacy sidebar behavior.
public/​docs/​js/​position-feedback-widget.js Targets the revised top bar.
public/​docs/​js/​use-custom-header-checkout-link.js Removes obsolete checkout-link customization.
src/​components/​InkeepSearch/​InkeepSearch.astro Compacts mobile search dimensions.
src/​components/​chrome/​Breadcrumb.astro Adds responsive breadcrumb variants.
src/​components/​chrome/​DocsNavToggle.astro Simplifies toggle styling.
src/​components/​chrome/​GetStartedButton.astro Extracts the header CTA.
src/​components/​chrome/​Hamburger.astro Adds an animated menu control.
src/​components/​chrome/​Header.astro Adds compact, scroll-hiding mobile behavior.
src/​components/​chrome/​LeftSidebar.astro Adds independent submenu controls.
src/​components/​chrome/​NavItem.astro Separates links from expansion buttons.
src/​components/​chrome/​PageNav.astro Converts the TOC into a mobile dropdown.
src/​components/​chrome/​TocToggle.astro Adds the mobile TOC trigger.
src/​icons/​chrome/​hamburger.svg Removes the replaced icon asset.
src/​layouts/​DefaultNewLayout.astro Passes header scroll behavior through.
src/​layouts/​NewDocsLayout.astro Integrates the redesigned mobile chrome.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/components/chrome/PageNav.astro Outdated
Comment thread src/components/chrome/PageNav.astro Outdated
@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch 2 times, most recently from 14a15e1 to 9dcc037 Compare October 5, 2026 11:50

@losrebellos losrebellos 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.

  1. Not sure it expected: when clicking on one of the bottom on this page link, the top nav disappear:
    Image
    And when click on one of the top on this page link, the top nav reappear
    Image
    Same on direct link with #... It seems to be acting as a scroll behaviour.
  2. Is the What's new button hover colour correct? The blue seems to be super dark.
  3. When a page has no on this page links, we should hide the h2, see here.

@tmashara

tmashara commented Oct 5, 2026

Copy link
Copy Markdown
Contributor Author
  1. Not sure it expected: when clicking on one of the bottom on this page link, the top nav disappear:
    expected, the same happens when user scrolls
  2. Is the What's new button hover colour correct? The blue seems to be super dark.
    fixed, thx!
image
  1. When a page has no on this page links, we should hide the h2
    already fixed, if you mean hiding "on this page" control
image

@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch 2 times, most recently from 76308fd to 5d96bc5 Compare October 5, 2026 13:28
@losrebellos
losrebellos self-requested a review October 5, 2026 13:36
tmashara and others added 2 commits October 5, 2026 18:52
Phone-only (below lg) changes, mirroring the marketing site's
docs-mobile-header-prototype branch:

- Site header shrinks to 56px, shows a `Metabase | Docs` mark linking to
  /docs/latest/, and hides on scroll-down / returns on scroll-up. The
  "Get started" button is 36px with an 8px radius; the burger no longer
  paints a hover background.
- The section bar is a fixed 40px strip spanning the viewport: menu
  toggle, search as a bare magnifier, and an "On this page" trigger with
  a chevron that flips when open.
- Breadcrumbs leave the bar and render as a plain slash-separated trail
  above the content; the Home crumb is a house icon in both trails.
- "On this page" opens a bottom sheet instead of an in-flow row.
- In the left nav, links always navigate; a separate chevron button
  toggles a branch.

Desktop is untouched apart from the hub label after the wordmark and the
nav chevron becoming a button.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The section bar and header now use the article's 20px gutter, with the
toggle buttons' padding hanging outside it, so the burger, wordmark,
breadcrumbs, content and "On this page" share one left and right edge.
The phone breadcrumb items are centred vertically so the Home icon sits
on the text's midline.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
tmashara and others added 6 commits October 5, 2026 18:52
The legacy sheet positions the divider absolutely with a 3px nudge for
the chevron image, which left the slash sitting above the text.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@tmashara
tmashara force-pushed the docs-mobile-header-prototype branch from 5d96bc5 to ca481f2 Compare October 5, 2026 17:11
@tmashara
tmashara merged commit fffa03b into master Oct 6, 2026
6 checks passed
@tmashara
tmashara deleted the docs-mobile-header-prototype branch October 6, 2026 10:54
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