Skip to content

TOC: Dissolve Handbook section into individual sections#547

Merged
bmunkholm merged 3 commits intomainfrom
bm/toc-restructure
Feb 12, 2026
Merged

TOC: Dissolve Handbook section into individual sections#547
bmunkholm merged 3 commits intomainfrom
bm/toc-restructure

Conversation

@bmunkholm
Copy link
Contributor

@bmunkholm bmunkholm commented Feb 11, 2026

@coderabbitai
Copy link

coderabbitai bot commented Feb 11, 2026

Walkthrough

Removed the Handbook index page, restructured the main docs index into multiple toctrees, added an Overview index page, renamed the Install heading to Installation, and bumped the crate-docs-theme requirement.

Changes

Cohort / File(s) Summary
Handbook removal
docs/handbook/index.md
Deleted the Handbook index page, its grid layout, sections, and toctree references to handbook sub-pages.
Main index updates
docs/index.md
Split navigation into multiple toctrees, removed the Handbook Quick Links card, adjusted hero/product copy and minor formatting/text tweaks.
Overview addition
docs/overview/index.md
Added new Overview page with a hidden toctree referencing solution content.
Installation heading change
docs/install/index.md
Renamed top-level heading from "Install" to "Installation".
Theme requirement bump
docs/requirements.txt
Updated crate-docs-theme version requirement to >=0.49.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

reorganize, maintenance, refactoring

Suggested reviewers

  • kneth
  • surister
  • amotl

Poem

🐇
I nibbled through the handbook trail,
Pages folded into a tidy tale.
A new overview hops into view,
Install renamed — fresh and true.
Hooray! 🥕📚

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: dissolving the Handbook section into individual sections, which is reflected in the deletion of docs/handbook/index.md and restructuring of the TOC in docs/index.md.
Description check ✅ Passed The description clearly references the related GitHub issue and theme dependency changes, providing context for the restructuring work and a preview build link.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bm/toc-restructure

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
docs/requirements.txt (1)

1-1: Consider a more restrictive version constraint.

The current constraint >=0.49.0 will accept any future minor version (e.g., 0.50.0, 0.51.0), which could introduce breaking changes. Consider using a constraint like >=0.49.0,<0.50.0 to limit the scope to compatible patch releases.

📌 Proposed fix for more restrictive versioning
-crate-docs-theme>=0.49.0
+crate-docs-theme>=0.49.0,<0.50.0

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@bmunkholm bmunkholm marked this pull request as ready for review February 11, 2026 22:47
Copy link
Member

@amotl amotl left a comment

Choose a reason for hiding this comment

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

This looks great! 💯

@bmunkholm bmunkholm merged commit 3f13f4a into main Feb 12, 2026
2 of 5 checks passed
@bmunkholm bmunkholm deleted the bm/toc-restructure branch February 12, 2026 13:11
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

Comments