Skip to content

Add some clarity to the pro-plan note #368

Open
@jmacdotorg

Description

@jmacdotorg
Contributor

We have a standard note (in src/components/ProPlanNotice.mdx) that we include on pages or sections defining features that are available only in the pro plan. It looks like this:

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 for more information about our plans and features.

While that is true as written, I think it could be more clear—especially regarding public repositories that get all Pro-tier plan features for free, even when they're associated with Lite-tier CodeRabbit accounts.

Activity

added
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on May 30, 2025
traycerai

traycerai commented on May 30, 2025

@traycerai

Plan

Observations

  • The current ProPlanNotice.mdx text warns that features are Pro-only but misses the public open-source exception.
  • Public open-source repositories receive all Pro-tier features for free (confirmed in docs/overview/introduction.md, docs/faq.md, and docs/guides/issue-chat.md).
  • The pricing page link (https://www.coderabbit.ai/pricing) is correct and up-to-date.
  • The shared component is imported in 9 documentation files under docs/, so updating it centrally will propagate the change everywhere.

Approach

  1. Update the central MDX component in src/components/ProPlanNotice.mdx to include the open-source exception.
  2. Preserve the existing admonition wrapper (:::info Pro Plan Feature) and pricing page link.
  3. Link to the canonical OSS policy page (docs/overview/introduction.md) for deeper context.
  4. Validate visually and in a local Docusaurus build across all usage locations (e.g. docs/tools/*.md, docs/changelog.md).
  5. Commit with a descriptive message referencing ticket Add some clarity to the pro-plan note #368 and request a docs review.

Reasoning

  • I reviewed the request to clarify the Pro-only note regarding open-source repositories.
  • I checked docs/overview/introduction.md, docs/faq.md, and docs/guides/issue-chat.md to confirm the free-for-public-OSS policy.
  • I mapped all imports and usage locations of the ProPlanNotice.mdx component across the docs/ folder.
  • I verified the pricing page URL by visiting https://www.coderabbit.ai/pricing.

Proposed File Changes

📄 src/components/ProPlanNotice.mdx (MODIFY) 🔗

References

In src/components/ProPlanNotice.mdx, locate the existing :::info Pro Plan Feature callout (lines 3–8) and replace its body text with the following block to call out the OSS exception:

:::info Pro Plan Feature
This feature is part of the Pro plan and not included in the Lite plan. However, public open-source repositories receive all Pro-tier features at no cost. Learn more in our [introduction](../overview/introduction) or see our [pricing page](https://www.coderabbit.ai/pricing) for full details.
:::

This single change will update the notice across all documentation pages that import this component. No other files need modification.

Import In IDE

VSCode Icon Cursor Icon Windsurf Icon

Developer Humor

A tiny plan of Pro and OSS,
Merged together in our docs’ gloss,
Now clarity beams,
Repos of dreams,
All free, all gleam! 🚀✨


Execution Information

Branch: main
Commit: 42a07ca


💡 Tips

Supported Commands (Inside Comments)

  • Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

  • Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
  • Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
self-assigned this
on Jun 2, 2025
removed
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @jmacdotorg

      Issue actions

        Add some clarity to the pro-plan note · Issue #368 · coderabbitai/coderabbit-docs