docs/updated integations page + added Storybook documentation page #414
Conversation
WalkthroughReclassifies several integrations from "internal" to "enterprise", adds Contentful, Zendesk, and Auth.js to integrations docs, updates some integration links, adds Storybook documentation, and aligns the IntegrationsBlocks component's status type and UI labels. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/src/pages/product/integrations.tsx (1)
29-39: Enterprise status updates and links look right; Zendesk status is inconsistentThe changes to:
- extend the
statusfield to'available' | 'planned' | 'enterprise',- mark SAP S/4 Hana, Keycloak, and Notification API as
enterprise, and- point Contentful and Zendesk to their documentation pages
are all consistent with the updated docs and component behavior.
One thing to fix:
- Zendesk is marked as
status: 'available'in the Customer Support section (with a docs link), but stillstatus: 'planned'and without a link in Knowledge Base Management. Given the new Zendesk docs and overview tile, this discrepancy is confusing.If Zendesk is now generally available, consider aligning the Knowledge Base entry with the Customer Support one:
{ title: 'Knowledge Base Management', description: 'Manage articles, FAQs, categories and tags for support content.', integrations: [ { name: 'Strapi', status: 'available', description: 'Used to model and manage article-based support knowledge base.', icon: <StrapiIcon />, link: '/docs/integrations/cms/strapi/overview', }, { name: 'Salesforce Service Cloud', status: 'planned', description: 'Enterprise CRM and customer case handling solution.', icon: <SalesforceIcon />, }, { name: 'Zendesk', - status: 'planned', - description: 'External ticketing and support knowledge base system.', - icon: <ZendeskIcon />, + status: 'available', + description: 'External ticketing and support knowledge base system.', + icon: <ZendeskIcon />, + link: '/docs/integrations/tickets/zendesk/overview', }, ], },Also applies to: 53-58, 79-84, 94-111, 113-131, 133-156, 171-176, 192-208
🧹 Nitpick comments (2)
apps/docs/docs/integrations/overview.md (1)
8-16: New integrations look consistent; consider small copy fixesThe added tiles for Contentful, Zendesk, Auth.js, and Notification API look consistent with the product integrations page and use the expected hrefs.
There are a couple of minor wording issues you may want to fix while you’re here:
-This sections provides a list of all integrations that are a part of the open-source project. +This section provides a list of all integrations that are part of the open-source project. ... -- [how to extend and integration](../guides/integrations/extending-integrations.md), +- [how to extend an integration](../guides/integrations/extending-integrations.md),Also applies to: 24-31, 39-45, 49-55
apps/docs/src/components/IntegrationsBlocks/index.tsx (1)
16-22: Enterprise status wiring looks good; consider deduplicating the status typeThe new
'enterprise'status is correctly threaded through the props andgetStatusConfig, with its own label and visual treatment, so this should work cleanly with the updated data.To avoid the status union drifting between the interface and helper, you could extract a shared status type in this file:
-export interface IntegrationsBlocksProps { - title: string; - description: string; - integrations: { - name: string; - description: string; - status: 'available' | 'planned' | 'enterprise'; - icon?: React.ReactNode; - link?: string; - }[]; -} +type IntegrationStatus = 'available' | 'planned' | 'enterprise'; + +export interface IntegrationsBlocksProps { + title: string; + description: string; + integrations: { + name: string; + description: string; + status: IntegrationStatus; + icon?: React.ReactNode; + link?: string; + }[]; +} -const getStatusConfig = (status: 'available' | 'planned' | 'enterprise') => { +const getStatusConfig = (status: IntegrationStatus) => {Also applies to: 24-55
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
apps/docs/src/assets/navbar/o2s-icon-dev.svgis excluded by!**/*.svgapps/docs/src/assets/navbar/o2s-icon-documentation.svgis excluded by!**/*.svgapps/docs/src/assets/navbar/o2s-icon-features.svgis excluded by!**/*.svg
📒 Files selected for processing (4)
apps/docs/docs/integrations/overview.md(2 hunks)apps/docs/docs/main-components/frontend-app/storybook.md(1 hunks)apps/docs/src/components/IntegrationsBlocks/index.tsx(2 hunks)apps/docs/src/pages/product/integrations.tsx(7 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: deploy-preview
🔇 Additional comments (1)
apps/docs/docs/main-components/frontend-app/storybook.md (1)
1-97: Storybook documentation is clear and aligned with the projectThe commands, file globs, and example story structure are coherent and match the described setup. This page should be immediately useful for contributors without requiring further tweaks.
What does this PR do?
Key Changes
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.