Skip to content

fix(mkdocs): integrate TOC into sidebar and add missing nav pages - #21

Open
gundalow wants to merge 1 commit into
ansible-community:mainfrom
gundalow:bug-sidebar
Open

fix(mkdocs): integrate TOC into sidebar and add missing nav pages#21
gundalow wants to merge 1 commit into
ansible-community:mainfrom
gundalow:bug-sidebar

Conversation

@gundalow

@gundalow gundalow commented Jul 26, 2026

Copy link
Copy Markdown

Summary

Fixes #19 — make the sidebar work similarly to Navigator's docsite.

  • Enable 8 mkdocs-material theme features (toc.integrate, navigation.sections, navigation.expand, etc.) to match Navigator's sidebar behavior
  • Add 5 doc files that existed on disk but were missing from the nav: configuration
  • Reorder nav to place Installation and Getting Started near the top, License at the bottom

Before

Left sidebar shows flat nav items. Right sidebar shows a separate "Table of contents" panel for page headings. "References" is collapsed behind a chevron.

contributor-guide-before home-before maintainer-guide-before references-cli-before

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.

contributor-guide-after home-after maintainer-guide-after references-cli-after

Test plan

  • mkdocs build --strict passes with no warnings
  • Serve locally (mkdocs serve) and verify:
    • Right sidebar is gone; page TOC appears under active page in left sidebar
    • "References" and "User guide" render as bold section headings, auto-expanded
    • All 10 doc pages appear in the nav (no orphans)
    • Code blocks have copy button; pages have edit pencil icon

🤖 Generated with Claude Code

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
gundalow requested review from anweshadas and samccann and removed request for anweshadas July 26, 2026 15:40
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.

project-template docsite: make the sidebar work similar as on navigator's docsite

1 participant