Skip to content

Reorganize docs nav into three top-level tabs#92

Merged
chris-colinsky merged 1 commit into
mainfrom
chore/docs-nav-tabs
May 29, 2026
Merged

Reorganize docs nav into three top-level tabs#92
chris-colinsky merged 1 commit into
mainfrom
chore/docs-nav-tabs

Conversation

@chris-colinsky
Copy link
Copy Markdown
Member

@chris-colinsky chris-colinsky commented May 29, 2026

Summary

The docs sidebar had grown long enough to scroll vertically even at full height, because navigation.sections rendered every section fully expanded as one flat list.

  • Switch to navigation.tabs + navigation.expand: the top-level areas become header tabs, and each tab's sidebar shows its pages open.
  • Regroup the nav under three tabs: Documentation (home, Getting Started, Concepts, Model Providers, Reference), Examples, and Patterns.

No page content or URLs change, only nav grouping and theme features.

Test plan

  • mkdocs build --strict clean
  • mkdocs serve shows the three tabs with the sidebar scoped per tab
  • CI (docs build, pytest, lint)

The sidebar had grown long enough to scroll at full height because
navigation.sections rendered every section fully expanded. Switch to
navigation.tabs (with navigation.expand) so the top-level areas
become header tabs and each tab's sidebar shows its pages open.

Regroup the nav under three tabs. Documentation holds the home page,
Getting Started, Concepts, Model Providers, and Reference; Examples
and Patterns are their own tabs. No pages or URLs change.
Copilot AI review requested due to automatic review settings May 29, 2026 01:14
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR reorganizes the MkDocs Material documentation navigation to reduce sidebar vertical sprawl by switching from a single expanded section list to three top-level navigation tabs.

Changes:

  • Replaced navigation.sections with navigation.tabs + navigation.expand in the Material theme features.
  • Regrouped nav into three top-level tabs: Documentation, Examples, and Patterns.
  • Moved Model Providers and Reference under the Documentation tab (no page paths changed).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chris-colinsky chris-colinsky merged commit 95b5f14 into main May 29, 2026
7 checks passed
@chris-colinsky chris-colinsky deleted the chore/docs-nav-tabs branch May 29, 2026 01:16
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.

2 participants