Skip to content

docs(home): keep the table of contents on the home page, only the side nav is hidden - #165

Merged
GeiserX merged 1 commit into
mainfrom
docs/home-keep-toc
Sep 30, 2026
Merged

GeiserX merged 1 commit into
mainfrom
docs/home-keep-toc

Conversation

@GeiserX

@GeiserX GeiserX commented Sep 30, 2026 •

Copy link
Copy Markdown
Owner

The home page should hide only the left navigation; the table of contents on the right belongs there like on every other page. This drops toc from the home page's hide: front matter.

mkdocs build --strict exits 0. Hidden-sidebar counts: home page toc 0, nav 1; getting-started toc 0, nav 0 (live site before this change: toc 1, nav 1).

Summary by CodeRabbit

  • Documentation
    • The table of contents is now visible; navigation remains hidden.

@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: GeiserX/LynxPrompt/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: db45bb18-f050-4089-8393-cb9e0e44bfe2

📥 Commits

Reviewing files that changed from the base of the PR and between c42ddf2 and 22e201b.

📒 Files selected for processing (1)
  • docs/index.md
💤 Files with no reviewable changes (1)
  • docs/index.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation configuration no longer hides the table of contents. It continues to hide navigation.

Changes

Documentation navigation

Layer / File(s) Summary
Table of contents visibility
docs/index.md
The configuration removes toc from the hidden items. Navigation remains hidden.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 22e20

The home page will show the right-side table of contents while still hiding the left navigation. This is a low-risk documentation change and is ready to merge.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change and reports a successful strict build, but it omits the required template sections, checklists, deployment notes, and screenshots section. Rewrite the description using the repository template. Include the summary, type of change, database changes, testing checklist, security checklist, deployment notes, and screenshots section. Mark each applicable item.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the primary documentation change: keeping the table of contents visible while hiding only the side navigation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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.

@GeiserX
GeiserX merged commit 0e64404 into main Sep 30, 2026
8 checks passed
@GeiserX
GeiserX deleted the docs/home-keep-toc branch September 30, 2026 16:31
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.

1 participant