📝 Table Of Contents Support

[ariflogs]

Summary by CodeRabbit

• New Features

  • Added an on-page Table of Contents for docs, with sticky positioning on large screens.
  • Introduced a responsive three-column docs layout with a sticky left sidebar and main content focus.

• Navigation

  • Top navigation labels updated: “Documentation” → “Docs”, “Blogs” → “Blog”.
  • Added Pro links (Blocks, Templates, Figma Kit) to the sidebar; external links open in a new tab.

• Style

  • Custom, subtle scrollbar for the sidebar.
  • Adjusted z-index and spacing for improved layering and readability.

• Chores

  • Added dependencies to support TOC generation.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
retro-ui	Ready	Preview	Comment	Aug 18, 2025 1:39pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Converts the docs page to async, generates and renders a Table of Contents, and restructures the docs layout into a three-column responsive design. Adds a new TableOfContents component and TOC generation utility, updates SideNav styling/behavior, tweaks global/layout styles, updates navigation labels, and adds remark/mdast dependencies.

Changes

Cohort / File(s)	Summary
Docs page layout + TOC integration app/(docs)/docs/[[...slug]]/page.tsx, app/(docs)/docs/layout.tsx	Page becomes async to await TOC; new three-column layout with sticky SideNav and TOC on large screens; structural class updates and content placement adjustments; layout wrapper simplified with wider container and removed SideNav offset.
Table of Contents feature components/TableOfContents.tsx, lib/toc.ts, contentlayer.config.ts, package.json	New TOC component rendering nested items; new TOC generator using remark and mdast-util-toc; remark-toc added to Contentlayer Blog processing; dependencies added: remark, remark-toc, mdast-util-toc, unist, vfile.
SideNav overhaul components/SideNav.tsx	Sidebar reworked to responsive, scrollable container; heading level adjusted; link targets set based on external/internal; badges and item layout updated.
Global/UI styling tweaks app/global.css, app/layout.tsx	Adds custom scrollbar styles via .sidebar-scroll; reduces TopNav wrapper z-index from z-40 to z-10.
Navigation labels/data config/navigation.ts	Top nav labels changed (“Documentation”→“Docs”, “Blogs”→“Blog”); adds three Pro external links in Getting Started with tags.

Sequence Diagram(s)

sequenceDiagram
  participant Page as Docs Page (async)
  participant TOCGen as generateToc (remark/mdast-toc)
  participant TOC as TableOfContents
  participant SideNav as SideNav

  Page->>TOCGen: generateToc(doc.body.raw)
  TOCGen-->>Page: toc (items, urls, titles)
  Page->>SideNav: Render left sidebar
  Page->>TOC: Render with toc on right
  Note over Page: Main column renders title, links, MDX, last updated

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

• Select #40 — Also modifies components/SideNav.tsx with container/scroll/layout changes.
• New Install guide #44 — Also edits app/(docs)/docs/[[...slug]]/page.tsx with import and heading adjustments.
• Added blogs Blogs #37 — Also updates contentlayer.config.ts for Blog processing configuration.

Poem

In margins wide, my whiskers twitch with glee,
A toc of trails maps burrows we can see.
Left rails scroll, right pages sing,
Headings hop in tidy ring.
With gentle z and polished scroll,
I bound through docs—carrot for the soul. 🥕✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e538b68 and aa5238c.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (10)

• app/(docs)/docs/[[...slug]]/page.tsx (2 hunks)
• app/(docs)/docs/layout.tsx (1 hunks)
• app/global.css (1 hunks)
• app/layout.tsx (1 hunks)
• components/SideNav.tsx (1 hunks)
• components/TableOfContents.tsx (1 hunks)
• config/navigation.ts (2 hunks)
• contentlayer.config.ts (3 hunks)
• lib/toc.ts (1 hunks)
• package.json (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch toc

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.