fix: Read the docs button on /ratelimits page was redirecting users to the home documentation page now after this fix it is redirecting users to specific Rate Limits documentation. #2624
Conversation
…instead-of-redirecting-global-docs
…instead-of-redirecting-global-doc
BadriVishalPadhy
requested review from
perkinsjr,
chronark,
mcstepp and
MichaelUnkey
as code owners
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@BadriVishalPadhy is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThe changes in this pull request involve modifications to the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
github-actions
bot
added
🕹️ 50 points
Bug
|
Thank you for following the naming conventions for pull request titles! 🙏 |
BadriVishalPadhy
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
packages/api/src/openapi.d.ts (1)
1067-1069: Documentation formatting could be improved.The description has some formatting issues with extra whitespace and could be more concise.
Consider updating the description to:
- * @description The day of the month, when we will refill the remaining verifications. To refill on the 15th of each month, set 'refillDay': 15. - * If the day does not exist, for example you specified the 30th and it's february, we will refill them on the last day of the month instead. + * @description The day of the month when verifications will be refilled. If the specified day doesn't exist (e.g., 30th in February), refill occurs on the last day of the month.Also applies to: 1080-1084
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
apps/dashboard/app/(app)/ratelimits/page.tsx(1 hunks)packages/api/src/openapi.d.ts(7 hunks)
🔇 Additional comments (2)
apps/dashboard/app/(app)/ratelimits/page.tsx (1)
Line range hint 84-89: LGTM! Documentation link updated correctly.
The change properly fixes the "Read the Docs" button redirection by updating the href from /docs to /docs/ratelimiting/introduction, which aligns with the PR objectives to direct users to the specific Rate Limits documentation.
Let's verify that the documentation path exists:
✅ Verification successful
Documentation path exists and is properly referenced
The verification confirms that /docs/ratelimiting/introduction is a valid documentation path:
- Found in
apps/docs/mint.jsonas part of the documentation structure - Referenced consistently across multiple blog posts and documentation files
- The path matches the documentation structure and naming conventions used in the project
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the Rate Limits documentation page exists
# Expected: Find references to the rate limiting documentation path
# Search for the documentation path in markdown files
rg -t md "ratelimiting/introduction"
# Search for other references to this path
rg "ratelimiting/introduction" --type-not md
Length of output: 1626
packages/api/src/openapi.d.ts (1)
361-363: LGTM! Well-documented refill configuration.
The new refillDay property is thoroughly documented with clear explanations about:
- Non-zero indexing (1 is first day)
- Default behavior (first day of month)
- Nullability when interval is 'daily'
Also applies to: 378-383
packages/api/src/openapi.d.ts
Outdated
| /** @description The day verifications will refill each month, when interval is set to 'monthly' */ | ||
| refillDay?: number; |
There was a problem hiding this comment.
Documentation needs to be consistent with other sections.
The refillDay property documentation in the UpdateKey operation is missing important details that are present in other sections.
Add the following details to match other sections:
- /** @description The day verifications will refill each month, when interval is set to 'monthly' */
+ /**
+ * @description The day verifications will refill each month, when interval is set to 'monthly'. Value is not zero-indexed making 1 the first day of the month. If left blank it will default to the first day of the month. When 'daily' is set for 'interval' 'refillDay' will be set to null.
+ * @default 1
+ * @example 15
+ */📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| /** @description The day verifications will refill each month, when interval is set to 'monthly' */ | |
| refillDay?: number; | |
| /** | |
| * @description The day verifications will refill each month, when interval is set to 'monthly'. Value is not zero-indexed making 1 the first day of the month. If left blank it will default to the first day of the month. When 'daily' is set for 'interval' 'refillDay' will be set to null. | |
| * @default 1 | |
| * @example 15 | |
| */ | |
| refillDay?: number; |
BadriVishalPadhy
changed the title
|
ok @perkinsjr |
|
hey @perkinsjr fixed the openapi.d.ts |
|
@perkinsjr hey can u merge it else if any queries plz do say |
BadriVishalPadhy
force-pushed
the
fix/ratelimits-button
branch
from
87fec2d
to
7b06d4b
Compare
What does this PR do?
Read the docs button on /ratelimits page was redirecting users to the home documentation page now after this fix it is redirecting users to specific Rate Limits documentation.
Fixes #2396
If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists
Type of change
How should this be tested?
Checklist
Required
pnpm buildpnpm fmtconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit
New Features
Bug Fixes
verifyKeyoperation, providing clearer validation codes for key management.