docs: clarify Pro-plan notice for OSS (#368) #397
Conversation
Signed-off-by: electricplayer <[email protected]>
WalkthroughThe Pro plan notice was updated to clarify plan inclusions, explicitly stating that the feature is part of the CodeRabbit Pro plan but not the Lite plan. It now specifies that public open-source repositories receive all Pro-tier features free of charge, while private repositories require an organizational subscription to the Pro tier or higher. The notice includes updated links to the introduction and pricing pages for more details. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-Merge Checks (2 passed, 1 warning)❌ Failed Checks (1 warning)
✅ Passed Checks (2 passed)
Impact AnalysisUpdated Pro Plan Notice Textℹ️ Low 🔄 Impacts behavior The informational notice in the ProPlanNotice component was revised to clarify that the feature is included in the CodeRabbit Pro plan and is free for public repositories, while private repository usage now requires an organizational Pro-tier (or higher) subscription. The pricing page link text was rephrased for clarity. Verify that the new wording accurately reflects subscription requirements and aligns with the pricing page. Ensure the MDX syntax changes didn’t introduce rendering issues. Render the ProPlanNotice in the application UI to confirm the updated text displays correctly and the pricing page link functions as expected. Check formatting across supported browsers and screen sizes. 🔍 Related Files
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🔍 MCP Research (2 servers)Linear: The ProPlanNotice component should clearly distinguish free Pro-tier feature access for public repos from private repo restrictions requiring organizational subscriptions. Reviewers must ensure the updated text aligns precisely with pricing page language and related issues (ENG-1545, ENG-1742) to maintain consistency. Confirm no unintended side effects on other uses of ProPlanNotice and recommend visual checks or snapshot tests to verify correct rendering of the revised notice. Linking related issues in PR comments improves traceability. Context7: The ProPlanNotice is a modular MDX React component consistently imported and reused across documentation to ensure uniform messaging about the Pro plan. This PR clarifies OSS usage and subscription terms, addressing prior ambiguity. Reviewers should confirm the updated text precisely matches subscription policies and that the component adheres to existing import and usage conventions. Visual verification in the Docusaurus preview suffices for testing. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (2)
src/components/ProPlanNotice.mdx (2)
5-6: Nitpick: refine phrasing and punctuation
For clarity and consistency, consider adding a comma after “public” and rephrasing for smoother reading. For example:- However, **public open-source repositories get every Pro-tier feature for free**. + However, **public, open-source repositories enjoy all Pro-tier features at no cost**.
7-8: Ensure single-sentence flow and verify link
Lines 7–8 split one sentence into two fragments and may render as separate paragraphs. Merge them and confirm that../overview/introductionresolves correctly:-Learn more in our [introduction](../overview/introduction) and see the full comparison -on the [pricing page](https://www.coderabbit.ai/pricing). +Learn more in our [introduction](../overview/introduction) and see the full comparison on the [pricing page](https://www.coderabbit.ai/pricing).
src/components/ProPlanNotice.mdx
Outdated
| @@ -2,6 +2,9 @@ | |||
|
|
|||
| :::info Pro Plan Feature | |||
|
|
|||
| This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. | |||
| This feature is part of the **Pro plan** and not included in the Lite plan. | |||
There was a problem hiding this comment.
Let's reword this to be super-specific. It's not so much about open-source repos versus non-open, it's more about whether the repository is public or private.
How's this for a reword:
This feature is part of the CodeRabbit Pro plan. You can use it with any public repository for free. To use it with a private repository, your organization must subscribe to CodeRabbit at the Pro tier or above. For more information on CodeRabbit pricing plans, see Pricing.
Adds clarity to pro-pplan note
Tackles #368