You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds navigation.tabs/navigation.tabs.sticky and splits the top-level nav into two tabs: Documentation (unchanged existing nav) and Release notes (release notes + special thanks, as before).
Keeps the sidebar collapsed by default, matching current behavior (navigation.expand is not enabled).
Keeps the accompanying sidebar/header CSS refinements (padding, icon specificity fix, focus-visible fix, tab bar styling) and the mobile drawer scroll/focus fix in docs-theme.js.
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
The PR successfully implements tabbed navigation for 'Documentation' and 'Release notes' using MkDocs Material. While the overall analysis shows the changes are up to standards, there is a technical risk associated with the manual scroll and focus management added to docs-theme.js. This file is flagged as complex and currently lacks automated test coverage, which could lead to regressions in mobile navigation.
A primary concern is the CSS implementation in responsive.css; certain selectors are not scoped to the tabbed navigation state (.md-nav--lifted), which would cause layout breakage on the standard sidebar if tabs are ever disabled in mkdocs.yml. Additionally, minor inconsistencies in JavaScript syntax and YAML indentation should be addressed to maintain codebase quality.
About this PR
The new manual scroll and focus management logic in docs-theme.js lacks automated integration or regression tests. Given that this file is flagged as complex and lacks coverage, these changes introduce a maintenance risk for mobile UI stability.
Test suggestions
Verify mobile drawer scrollLeft is reset to 0 when opened to ensure active tab content is visible.
Verify focus management in the mobile drawer prioritizes links within the active tab subtree.
Test icon rendering logic in nav-item.html correctly identifies level 2 items when tabs are active.
Verify desktop CSS hides redundant top-level labels while keeping them visible on mobile.
Automate unit/integration testing for docs/assets/javascripts/docs-theme.js to address complexity and lack of coverage.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify mobile drawer scrollLeft is reset to 0 when opened to ensure active tab content is visible.
2. Verify focus management in the mobile drawer prioritizes links within the active tab subtree.
3. Test icon rendering logic in `nav-item.html` correctly identifies level 2 items when tabs are active.
4. Verify desktop CSS hides redundant top-level labels while keeping them visible on mobile.
5. Automate unit/integration testing for `docs/assets/javascripts/docs-theme.js` to address complexity and lack of coverage.
Introduces navigation.tabs and restructures the nav into four top-level
tabs (Product, Management, Developer Tools, Release Notes) with matching
sidebar icon and styling changes.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Scale the tabs down to two: Documentation (the existing nav, unchanged)
and Release notes (release notes plus special thanks, as before).
Drops the Product/Management/Developer Tools split and its icon
remapping, and restores the sidebar's original collapsed-by-default
behavior now that navigation.expand isn't enabled.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Scope the tab-label-hiding and top-item-styling selectors to
.md-nav--lifted (matching the pattern already used two rules below)
instead of .md-nav--primary, use const instead of var in docs-theme.js,
and fix the Reporting sub-list indentation in mkdocs.yml.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Puts it as the last top-level item in the Documentation tab, with
its heart icon restored, instead of under Release notes.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Safari doesn't implement scrollbar-gutter, so the existing stable-gutter
rule is a no-op there and the primary nav rail visibly narrows once a
scrollbar appears. Force overflow-y: scroll as a Safari-only fallback,
detected via the hanging-punctuation feature (Safari-exclusive since 2016).
…avior
Fixes a scroll jump on search open (scroll-padding-top on <html> caught the
search trigger's own focus() call, not just anchor jumps) by moving the
sticky-header offset to per-heading scroll-margin-top instead.
Aligns the desktop header to the content grid below it (logo/search/right
cluster columns match sidebar/content/toc) when a sidebar is visible, restores
the search backdrop blur, and repositions the search popup to overlap the
header on desktop instead of opening as a second, disconnected search bar.
Fixes the mobile search close button, which was permanently hidden behind a
hardcoded icon override, and fixes the click-outside-to-close overlay not
covering the full viewport on any breakpoint — caused by .md-header's
backdrop-filter turning it into a containing block for the fixed-position
search panel, so `inset: 0` resolved against the header's own short box
instead of the viewport.
Adds a border-bottom to the mobile header to match the divider line desktop
gets from the (hidden-on-mobile) tabs bar.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Icons the Cloud and Self-hosted sections (matching the pattern used
throughout the Documentation tab), and the Release notes intro page.
Fixes the meta.icon nav template branch, which pointed at Material's
unvendored icon set and never actually rendered, to use the same
vendored-ionicons macro as sidebar_icons.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
hide: - toc sets the native [hidden] attribute on the secondary
sidebar, which Material's :not([hidden]) selector doesn't match, so
the article lost its 1.2rem right margin and rendered 6.4px wider
than every other page.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
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.
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
Summary
navigation.tabs/navigation.tabs.stickyand splits the top-level nav into two tabs: Documentation (unchanged existing nav) and Release notes (release notes + special thanks, as before).navigation.expandis not enabled).docs-theme.js.Closes #2711
Test plan
mkdocs servelocally; verified both tabs render with correct icons🤖 Generated with Claude Code