Add rate limits to documentation

[jmacdotorg]

Currently, rate limits are made specific only in the FAQ on the main site. These should be added to the documentation. We should also decide whether to have the information in both locations, or (my preference) have the FAQ link to the documentation so as not to risk

• Confirm with CodeRabbit staff that the rate limits information in the FAQ is up to date
• Draft new rate limit documentation—including various tiers, situations, and sub-products such as the VSCode extension
• Update the FAQ on the main site as needed

[linear]

ENG-1648 Add rate limits to documentation

[traycerai]

Plan

Observations

Rate-limit details live in docs/faq.md (lines 198-214) and scattered one-liners in introduction/vscode pages. No dedicated reference page exists. Sidebar structure under the “Reference” category is explicit; new docs must be registered there. Lint/build rules are standard Docusaurus with markdownlint & Prettier; default admonitions allowed; links must be root-relative. Our goal is to create a single authoritative rate-limits document, cross-link callers, and keep build green.

Approach

Create docs/reference/rate-limits.md containing migrated & expanded content (intro, full table, burst vs sustained, IDE limits, enforcement & disclaimer). Remove the old Usage Limits section from docs/faq.md and replace with a short tip that links to the new page. Add the new doc to the Reference items array in sidebars.ts, just after reference/caching. Optionally convert brief mentions in introduction and VSCode guide into inline links. Run lint/build locally before commit.

Reasoning

Inspected docs directory, FAQ content, sidebar configuration, lint rules, and public FAQ/pricing pages to aggregate current limits and formatting conventions. Identified duplicate/brief mentions and the correct navigation slot for a new reference doc.

Proposed File Changes

📄 docs/reference/rate-limits.md ^(NEW) 🔗

References

• 📄 docs/faq.md ^(MODIFY)

Create a new markdown file with front-matter (id: rate-limits, title: Rate limits, description). Structure: 1) concise intro explaining why limits exist, 2) Current limits table migrated from docs/faq.md lines 208-213 and augmented with IDE-specific rows and burst vs sustained notes, 3) subsections for each plan (Free/OSS, Lite, Pro, Enterprise – with placeholders for future edits), 4) section “Burst vs sustained usage” with examples, 5) “VS Code & other IDE extensions” outlining any different quotas, 6) “How enforcement works & reset cadence” describing timeouts, 7) admonition noting figures may change – always consult this page. Use ## level headings, :::note or :::tip blocks where helpful, and keep markdownlint rules in mind. Insert root-relative links back to related docs where relevant.

📄 docs/faq.md ^(MODIFY) 🔗

References

• 📄 docs/reference/rate-limits.md ^(NEW)

Delete the entire block starting at heading ### Usage Limits through its closing admonition/table (approx. lines 198-214). In its place insert an admonition:

:::tip
Looking for rate-limit information? It now lives in our dedicated [Rate limits](/reference/rate-limits) page.
:::

📄 sidebars.ts ^(MODIFY) 🔗

References

• 📄 docs/reference/rate-limits.md ^(NEW)

Within the Reference category’s items array, add the string "reference/rate-limits" just after the existing "reference/caching" entry to surface the new page in site navigation. Ensure no trailing commas or lint issues arise.

📄 docs/overview/introduction.md ^(MODIFY) 🔗

References

• 📄 docs/reference/rate-limits.md ^(NEW)

Locate the single-sentence rate-limit mention (around line 91). Append a root-relative link: “… Rate limits might apply (see our Rate limits page).” Keep sentence length markdown-lint friendly.

📄 docs/guides/about-vscode.md ^(MODIFY) 🔗

References

• 📄 docs/reference/rate-limits.md ^(NEW)

In the ## Price and limitations section (around lines 28-32) amend the sentence to: “Rate limits apply to the number of local reviews you can request per hour; see the Rate limits page for details.” Ensure anchor matches the VS Code subsection heading created in the new doc.

Diagram

sequenceDiagram
  participant User
  participant DocsSite as "docs.coderabbit.ai"
  User->>DocsSite: Navigate sidebar
  DocsSite-->>User: /reference/rate-limits page
  User->>DocsSite: Click FAQ rate-limit link
  DocsSite-->>User: Redirects to same /reference/rate-limits

Loading

Import In IDE

Developer Humor

A table of limits marched into the docs one night,
Claiming the FAQ gave them stage-fright.
We built them a home in Reference land,
Now bursty reviews are all neatly planned!
🎩🐇

---

Execution Information

Branch: main
Commit: 43b2d89

---

💡 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.