fix(mkdocs): integrate TOC into sidebar and add missing nav pages - #21
Open
gundalow wants to merge 1 commit into
Open
fix(mkdocs): integrate TOC into sidebar and add missing nav pages#21gundalow wants to merge 1 commit into
gundalow wants to merge 1 commit into
Conversation
Enable mkdocs-material theme features to match Navigator's docsite sidebar behavior (fixes ansible-community#19). Add 5 doc files that were missing from the nav configuration. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
gundalow
requested review from
anweshadas and
samccann
and removed request for
anweshadas
July 26, 2026 15:40
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #19 — make the sidebar work similarly to Navigator's docsite.
toc.integrate,navigation.sections,navigation.expand, etc.) to match Navigator's sidebar behaviornav:configurationBefore
Left sidebar shows flat nav items. Right sidebar shows a separate "Table of contents" panel for page headings. "References" is collapsed behind a chevron.
After
Single left sidebar with TOC integrated under the active page. "User guide" and "References" render as bold section headings, auto-expanded. All 10 doc pages visible. Right sidebar removed. Edit icon added.
Test plan
mkdocs build --strictpasses with no warningsmkdocs serve) and verify:🤖 Generated with Claude Code