Skip to content

fix: only one rate limit doc - #2699

Open
vinckr wants to merge 3 commits into
masterfrom
vinckr/new-rate-limits-rolled-out
Open

fix: only one rate limit doc#2699
vinckr wants to merge 3 commits into
masterfrom
vinckr/new-rate-limits-rolled-out

Conversation

@vinckr

@vinckr vinckr commented Aug 3, 2026

Copy link
Copy Markdown
Member

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

Summary by CodeRabbit

  • Documentation
    • Updated the Operations sidebar with direct links to project and endpoint rate-limiting guides.
    • Added redirects from legacy rate-limiting URLs to the consolidated rate-limits guide.

Copilot AI review requested due to automatic review settings August 3, 2026 12:58
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The Operations sidebar now links directly to the project and endpoint rate-limit guides. Temporary redirects preserve access to the legacy and new rate-limit guide URLs.

Changes

Rate-limit navigation

Layer / File(s) Summary
Update rate-limit links and redirects
sidebars.ts, vercel.json
The Operations sidebar links directly to the project and endpoint guides. Legacy rate-limit paths redirect to /docs/guides/rate-limits.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • ory/docs#2460: Introduced the rate-limit sidebar structure updated by this PR.

Suggested reviewers: aeneasr

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description contains the template and checklist but omits the required summary of the change and its purpose. Add a brief summary that explains the sidebar changes, redirects, and consolidation of rate-limit documentation.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the main change: consolidating rate-limit documentation into one guide.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch vinckr/new-rate-limits-rolled-out

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Not ready to approve

The PR introduces at least one likely-broken relative doc link and uses non-permanent redirects for removed pages, which should be corrected before merge.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Pull request overview

This PR consolidates the “Rate limits” documentation into a single page and removes the legacy/new split, updating navigation and adding redirects so old URLs still resolve.

Changes:

  • Removes rate-limits-legacy and rate-limits-new docs and folds key guidance into docs/guides/rate-limits.mdx.
  • Updates the sidebar to list the remaining subpages directly under “Rate limits”.
  • Adds Vercel redirects from the removed doc routes to the unified rate limits page.
File summaries
File Description
vercel.json Adds redirects from removed rate-limit pages to the unified rate-limit doc.
sidebars.ts Removes the legacy/new rate limits entries and keeps only the remaining subpages.
docs/guides/rate-limits.mdx Rewrites the main rate limits page to be the single source of truth and adds client-handling guidance.
docs/guides/rate-limits-new.mdx Deletes the “new” rate limits page (content consolidated into the main page).
docs/guides/rate-limits-legacy.mdx Deletes the “legacy” rate limits page (content consolidated into the main page).
Review details
  • Files reviewed: 5/5 changed files
  • Comments generated: 4
  • Review effort level: Lite

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Comment thread vercel.json
Comment thread docs/guides/rate-limits.mdx Outdated
Comment thread docs/guides/rate-limits.mdx
Comment thread vercel.json

@unatasha8 unatasha8 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not merge yet.

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.

3 participants