docs: navigation restructure#174
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ 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. ✨ 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 |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 issues found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs.json">
<violation number="1" location="docs.json:138">
P2: The new Instagram nav links reference pages that do not exist, creating broken documentation routes.</violation>
<violation number="2" location="docs.json:371">
P2: The new Skills navigation entries point to pages that are not present in the repository, so users will hit 404s from the sidebar.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| { | ||
| "group": "Instagram", | ||
| "pages": [ | ||
| "api-reference/instagram/comments", |
There was a problem hiding this comment.
P2: The new Instagram nav links reference pages that do not exist, creating broken documentation routes.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs.json, line 138:
<comment>The new Instagram nav links reference pages that do not exist, creating broken documentation routes.</comment>
<file context>
@@ -157,19 +121,81 @@
+ {
+ "group": "Instagram",
+ "pages": [
+ "api-reference/instagram/comments",
+ "api-reference/instagram/profiles"
+ ]
</file context>
| { | ||
| "group": "Overview", | ||
| "pages": [ | ||
| "skills" |
There was a problem hiding this comment.
P2: The new Skills navigation entries point to pages that are not present in the repository, so users will hit 404s from the sidebar.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs.json, line 371:
<comment>The new Skills navigation entries point to pages that are not present in the repository, so users will hit 404s from the sidebar.</comment>
<file context>
@@ -330,40 +353,54 @@
+ {
+ "group": "Overview",
+ "pages": [
+ "skills"
+ ]
},
</file context>
Reorganizes the docs sidebar into a tab structure organized around
what agents actually do, rather than around HTTP verbs or resource
shapes. Pure docs.json change — no MDX content modified, no brand
fields touched.
New tab structure:
Overview - Start here / Interfaces / Skills entry points
Chat - AI Chat conversation endpoints
Research - Artist discovery + 9 sub-groups
(metrics, audience, playlists, charts, web, ...)
Artists - Artist Management + Fans & Posts
Catalog - Songs + Catalogs
Content - Generate / Edit / Analyze / Templates / Legacy /
Content Agent (verb-based, matches Research style)
Automation - Scheduled Tasks / Pulses / Notifications
Accounts - Agent Onboarding + Accounts/Orgs/Sandboxes/...
Skills - 10 skill playbooks
Within each tab, groups use single-verb or short-phrase names
(Generate, Edit, Analyze) rather than the previous
"Content Endpoints" / "Pipeline Endpoints" pattern. This matches the
naming convention Research already uses (Artist discovery,
Metrics & insights, Charts & radio).
Also touches:
- navbar: GitHub moved from sidebar global anchors to navbar links;
Launch App removed (redundant with primary "Get API Key" CTA);
Blog and Support kept.
- global anchors: emptied (no more competing CTAs at the top of the
sidebar; the navbar handles it).
- contextual: enables copy/view/chatgpt/claude/perplexity/mcp/cursor/
vscode export options on every page.
This PR depends on the Skills system (PR 6 of the stack) and the
agent-first onboarding pages (PR 5) for its referenced page slugs to
exist. If this lands before those, several nav entries will 404
until they merge — recommend reviewing/landing 5 and 6 first.
Made-with: Cursor
recoupableorg
force-pushed
the
feat/docs-nav
branch
from
128350c to
a712a67
Compare
PR #174's nav structure was written Apr 27, before three pages were added to main: - api-reference/ai/models (added by #177 on May 1) - api-reference/sessions/create (added by #186 on May 3) - api-reference/sessions/get (added by #185 on May 4) These pages exist on disk but had no nav entry in the combined PR, which would orphan them once #189 lands. Adding them in: - Accounts tab → new "Sessions" group placed after "Sandboxes" (matches main's grouping of sessions with sandboxes) - Chat tab → new "Models" group at the end (closest semantic fit; main grouped this under "Tools & Reference" which doesn't exist in our restructured 9-tab layout) Co-authored-by: Cursor <cursoragent@cursor.com>
PR #174's nav was written Apr 27. On Apr 28, main #163 ("docs: remove instagram scrape endpoints") deleted these two MDX files entirely: - api-reference/instagram/comments.mdx - api-reference/instagram/profiles.mdx The combined PR's nav still pointed at them, which would 404 in production. Removing the nav entries to match main's intent. Co-authored-by: Cursor <cursoragent@cursor.com>
2 participants
Summary
Reorganizes the docs sidebar into tabs organized around what agents do, rather than HTTP verbs or resource shapes. Pure `docs.json` change — no MDX modified, no brand fields touched.
New tab structure
Within each tab, groups use single-verb or short-phrase names (e.g. `Generate`, `Edit`, `Analyze`) — matches the convention Research already uses.
Other docs.json changes
Stack & dependencies
PR 7 of 7. Replaces #145. Depends conceptually on:
If this lands before those, several nav entries will 404 until the others merge. Recommend reviewing and landing 5, 6 first, then this.
What this PR does NOT change
`theme`, `colors`, `fonts`, `background`, `styling`, `icons`, `logo`, `appearance` — all byte-identical to main. Brand changes ship in PR 1 (`feat/docs-brand`).
Made with Cursor