Skip to content

docs(web): add icons for CLI/broker API reference nav items#886

Merged
willwashburn merged 1 commit into
mainfrom
claude/add-nav-icons-tqzpH
May 18, 2026
Merged

docs(web): add icons for CLI/broker API reference nav items#886
willwashburn merged 1 commit into
mainfrom
claude/add-nav-icons-tqzpH

Conversation

@willwashburn
Copy link
Copy Markdown
Member

Summary

  • The docs sidebar (web/components/docs/DocsNav.tsx) was rendering two nav items without icons because navIcons had no entries for their slugs:
    • CLI reference (reference-cli)
    • Broker HTTP / WS API (reference-broker-api)
  • Added BookOpen for the CLI reference and Network for the broker HTTP/WS API (both from lucide-react, matching the existing icon style).

Test plan

  • Visit /docs/* and confirm every item under the CLI group renders with a leading icon.
  • Confirm "CLI reference" shows a book icon and "Broker HTTP / WS API" shows a network icon.
  • No icon spacing/alignment regressions elsewhere in the sidebar.

Generated by Claude Code

The docs sidebar was rendering "CLI reference" and "Broker HTTP / WS API"
without icons because no entries existed in navIcons for the
reference-cli and reference-broker-api slugs.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 60b28df6-501e-46d5-9909-177f23a5c59d

📥 Commits

Reviewing files that changed from the base of the PR and between 1bd6e48 and b89d874.

📒 Files selected for processing (1)
  • web/components/docs/DocsNav.tsx

📝 Walkthrough

Walkthrough

The PR adds a BookOpen icon import to the DocsNav component and maps the reference-cli documentation route to display this icon in the navigation. No other behavior or API changes were made.

Changes

CLI Reference Documentation Navigation

Layer / File(s) Summary
CLI reference icon mapping
web/components/docs/DocsNav.tsx
BookOpen icon is imported from lucide-react and mapped to the reference-cli route slug in the navIcons lookup table.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • khaliqgant

Poem

📖 A BookOpen icon hops in with glee,
For CLI docs, now all can clearly see,
One line to import, one line to apply,
The reference guides wave hello from on high! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding icons for CLI and broker API reference navigation items in the docs.
Description check ✅ Passed The description covers the required sections with clear context about what was changed and why, plus a detailed test plan with checkboxes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/add-nav-icons-tqzpH

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

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

@willwashburn willwashburn merged commit 5fef86b into main May 18, 2026
29 of 31 checks passed
@willwashburn willwashburn deleted the claude/add-nav-icons-tqzpH branch May 18, 2026 05:33
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.

2 participants