fix: address PR #102 review feedback#103
Conversation
- Fix section count: "five" → "six" to match actual card count - Add missing research endpoints (track, instagram-posts) to LLM reference - Revert base URL to api.recoupable.com for consistency with authentication.mdx and openapi.json Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 23 minutes and 52 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates documentation files by revising API endpoint URLs in authentication examples, reordering navigation structure in the sidebar configuration, and refreshing marketing copy with adjusted endpoint listings and section counts. Changes
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly Related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Update index, quickstart, and authentication pages to consistently use recoup-api.vercel.app as the canonical API base URL. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
- Update intro text to highlight content generation and catalogs - KISS: remove "AI-powered" from Chat card description - KISS: remove "AI" from Content Agent card description - Move /api/artists/* to first in LLM quick reference Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
index.mdx
Outdated
| # Welcome to the Recoup API | ||
|
|
||
| Use the Recoup API to build your record label. Access artist analytics, fan segmentation, AI-powered chat, content creation, and task automation to power your music business. | ||
| Use the Recoup API to build your record label. Generate content, Access artist analytics, Manage your catalogs, AI-powered chat, and task automation to power your music business. |
There was a problem hiding this comment.
KISS
| Use the Recoup API to build your record label. Generate content, Access artist analytics, Manage your catalogs, AI-powered chat, and task automation to power your music business. | |
| Use the Recoup API to build your record label. Generate content, Access artist analytics, Manage catalogs, Team chats, and task automation to power your record labels. |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
index.mdx (1)
8-8:⚠️ Potential issue | 🟡 MinorPolish the hero sentence grammar/casing for readability.
Mid-sentence capitalization and pluralization make this line read awkwardly (
Access,Manage,Team,record labels). Suggest a quick copy pass for consistency and scanability.
As per coding guidelines: "Keep documentation content concise and scannable."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@index.mdx` at line 8, Update the hero sentence in index.mdx to use sentence case and a parallel list structure: make verbs lowercased and consistent (e.g., "generate content, access artist analytics, manage catalogs"), fix pluralization for "record label(s)" to match the product focus, and ensure items are scannable and punctuated consistently (use commas and an Oxford comma). Locate the hero line text ("Use the Recoup API to build your record label. Generate content, Access artist analytics, Manage catalogs, Team chats, and task automation to power your record labels.") and replace it with a single, grammatically consistent sentence that follows sentence case and parallel verb forms.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@authentication.mdx`:
- Line 38: Replace the non-canonical domain used in the curl examples by
updating the URL string "https://recoup-api.vercel.app/api/tasks" (and the other
occurrence at line 60) to the canonical API base "https://api.recoupable.com" so
the authentication.mdx examples match api-reference/openapi.json; ensure both
instances are changed to avoid docs/spec drift.
---
Duplicate comments:
In `@index.mdx`:
- Line 8: Update the hero sentence in index.mdx to use sentence case and a
parallel list structure: make verbs lowercased and consistent (e.g., "generate
content, access artist analytics, manage catalogs"), fix pluralization for
"record label(s)" to match the product focus, and ensure items are scannable and
punctuated consistently (use commas and an Oxford comma). Locate the hero line
text ("Use the Recoup API to build your record label. Generate content, Access
artist analytics, Manage catalogs, Team chats, and task automation to power your
record labels.") and replace it with a single, grammatically consistent sentence
that follows sentence case and parallel verb forms.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7ac64917-c521-4ee8-81e0-0331822c5503
📒 Files selected for processing (3)
authentication.mdxdocs.jsonindex.mdx
|
|
||
| ```bash | ||
| curl -X GET "https://api.recoupable.com/api/tasks" \ | ||
| curl -X GET "https://recoup-api.vercel.app/api/tasks" \ |
There was a problem hiding this comment.
Use one canonical API base URL here to avoid spec/docs drift.
These two examples now point to recoup-api.vercel.app, but api-reference/openapi.json still declares https://api.recoupable.com and the PR objective says to revert to that domain. This mismatch will confuse users and breaks consistency.
Proposed fix
-curl -X GET "https://recoup-api.vercel.app/api/tasks" \
+curl -X GET "https://api.recoupable.com/api/tasks" \
-H "x-api-key: YOUR_API_KEY"-curl -X GET "https://recoup-api.vercel.app/api/tasks" \
+curl -X GET "https://api.recoupable.com/api/tasks" \
-H "Authorization: Bearer YOUR_PRIVY_JWT"Also applies to: 60-60
🧰 Tools
🪛 Betterleaks (1.1.1)
[high] 38-39: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@authentication.mdx` at line 38, Replace the non-canonical domain used in the
curl examples by updating the URL string
"https://recoup-api.vercel.app/api/tasks" (and the other occurrence at line 60)
to the canonical API base "https://api.recoupable.com" so the authentication.mdx
examples match api-reference/openapi.json; ensure both instances are changed to
avoid docs/spec drift.
1 participant
Summary
trackandinstagram-postsendpoints to the LLM quick referenceapi.recoupable.comfor consistency withauthentication.mdxandopenapi.jsonAddresses review comments from #102.
Test plan
🤖 Generated with Claude Code
Summary by cubic
Fix docs and wording per PR #102 feedback. Standardizes the base URL, corrects counts and ordering, simplifies copy, updates endpoint references, and clarifies the
/api/artistsdescription inopenapi.json.trackandinstagram-posts; list/api/artists/*before/api/research/*.https://recoup-api.vercel.app/apias the base URL across docs./api/artistslist endpoint description.Written for commit 200c2e8. Summary will update on new commits.