Skip to content

feat(desktop): add documentation links throughout the app#1096

Merged
Kitenite merged 10 commits into
mainfrom
add-docs-to-product
Jan 31, 2026
Merged

feat(desktop): add documentation links throughout the app#1096
Kitenite merged 10 commits into
mainfrom
add-docs-to-product

Conversation

@Kitenite
Copy link
Copy Markdown
Collaborator

@Kitenite Kitenite commented Jan 31, 2026

Summary

  • Add "Documentation" link to organization dropdown (after Keyboard Shortcuts)
  • Add "Documentation" item to Help menu bar (at top)
  • Add "Learn more" link to API Keys settings page (links to /mcp docs)
  • Add "Learn more" link to Integrations settings page (links to /integrations docs)
  • Add "Documentation" link to Settings sidebar footer

Test plan

  • Open org dropdown → verify "Documentation" item appears and opens docs site
  • Check Help menu → verify "Documentation" appears at top and opens docs site
  • Go to Settings > API Keys → verify "Learn more" link appears and opens MCP docs
  • Go to Settings > Integrations → verify "Learn more" link appears and opens integrations docs
  • Open Settings → verify "Documentation" link appears at bottom of sidebar and opens docs site

Summary by CodeRabbit

Release Notes

  • New Features
    • Added documentation links across multiple sections of the application, including the Help menu, organization dropdown, API Keys settings, settings sidebar, and Integrations settings, providing convenient access to external documentation resources.

✏️ Tip: You can customize this high-level summary in your review settings.

Add a Documentation menu item in the org dropdown that opens the docs
site in an external browser. Placed after Keyboard Shortcuts for easy
discoverability.
Add a Documentation item at the top of the Help menu in the macOS/Windows
menu bar. Opens the docs site in the default browser.
Add a "Learn more" link in the API Keys settings page header that opens
the MCP documentation. Helps users understand how to use API keys with
Claude Desktop and other MCP clients.
Add a "Learn more" link in the Integrations settings page footer that
opens the integrations documentation. Helps users understand how to set
up and configure external service integrations.
Add a Documentation link at the bottom of the settings sidebar that
opens the docs site in an external browser. Provides easy access to
documentation from anywhere within settings.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 31, 2026

Warning

Rate limit exceeded

@Kitenite has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

This pull request adds documentation links across multiple UI surfaces in the desktop application. A Documentation menu item is added to the Help submenu and organization dropdown, while "Learn more" links pointing to the company documentation URL are inserted into several settings pages (API Keys, Integrations, and the sidebar).

Changes

Cohort / File(s) Summary
Help Menu
apps/desktop/src/main/lib/menu.ts
Added Documentation menu item to Help submenu that opens COMPANY.DOCS_URL in a new tab, with separator inserted before existing Contact Us entry.
Navigation UI
apps/desktop/src/renderer/routes/_authenticated/_dashboard/components/TopBar/components/OrganizationDropdown/OrganizationDropdown.tsx
Added Documentation item to organization dropdown menu with HiOutlineBookOpen icon, linking to COMPANY.DOCS_URL in new tab.
Settings Pages
apps/desktop/src/renderer/routes/_authenticated/settings/api-keys/components/ApiKeysSettings/ApiKeysSettings.tsx, apps/desktop/src/renderer/routes/_authenticated/settings/components/SettingsSidebar/SettingsSidebar.tsx, apps/desktop/src/renderer/routes/_authenticated/settings/integrations/components/IntegrationsSettings/IntegrationsSettings.tsx
Added "Learn more" links to documentation across settings pages. ApiKeysSettings and IntegrationsSettings link to COMPANY.DOCS_URL/mcp and COMPANY.DOCS_URL respectively, with HiArrowTopRightOnSquare icon. SettingsSidebar adds new Documentation section with external link icon.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Through menus and dropdowns, the docs now appear,
Links guide the way, crystal clear,
From settings to sidebar, knowledge takes flight,
Help at your paws, always in sight! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation links throughout the desktop app.
Description check ✅ Passed The description provides a clear summary of changes and includes a test plan, but lacks sections like Related Issues and Type of Change from the template.

✏️ 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 add-docs-to-product

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.

Group menu items into three sections:
- Organization: Settings, Manage members, Switch organization
- Help & Support: Documentation, Keyboard Shortcuts, Report Issue, Contact Us
- Account: Log out
- Use IoBugOutline for Report Issue
- Use HiOutlineChatBubbleLeftRight for Contact Us
@Kitenite Kitenite merged commit 6ca33c1 into main Jan 31, 2026
5 checks passed
@Kitenite Kitenite deleted the add-docs-to-product branch January 31, 2026 22:40
@github-actions
Copy link
Copy Markdown
Contributor

🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:

  • ⚠️ Neon database branch
  • ⚠️ Electric Fly.io app

Thank you for your contribution! 🎉

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