Skip to content

docs: split Node and Java queue API reference into folders#419

Merged
pratyush618 merged 2 commits into
masterfrom
docs/node-java-queue-split
Jul 12, 2026
Merged

docs: split Node and Java queue API reference into folders#419
pratyush618 merged 2 commits into
masterfrom
docs/node-java-queue-split

Conversation

@pratyush618

Copy link
Copy Markdown
Collaborator

Problem

The API Reference Queue page had inconsistent structure across SDKs. The Python SDK splits its Queue reference into a nested queue/ folder (index + Job Management, Queue & Stats, Workers & Hooks, Resources & Locking, Events & Logs, Pub/Sub), giving an expandable sidebar subtree. Node and Java crammed the entire Queue API onto a single flat queue.mdx, so their sidebars showed one entry with no sub-navigation.

Fix

Restructure Node and Java to mirror the Python layout: convert each flat queue.mdx into a queue/ folder with the same 7-page split and a meta.json ordering the sub-pages. A "Sub-pages" callout on each index links the subtree, matching Python.

This is a pure reorganization of existing content — no API added, removed, or reworded:

  • Every backticked identifier from the old flat pages is present in the new folders (verified by diff — zero dropped tokens).
  • The landing route is unchanged: /node/api-reference/queue and /java/api-reference/queue still resolve (folder index), so all existing cross-links keep working. Java keeps its Taskito landing title.
  • Each SDK links only within itself.

Pages

Both SDKs now have: index, jobs, queues, workers, resources, events, pubsub.

Verification

  • pnpm --dir docs lint — pass
  • pnpm --dir docs build — static export succeeds; all 14 new routes prerender, no duplicate-route warnings

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 21 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 208b7cd4-d0fb-4b06-9682-7128da6b942d

📥 Commits

Reviewing files that changed from the base of the PR and between 4aca74b and 20a4b94.

📒 Files selected for processing (18)
  • docs/content/docs/java/api-reference/queue.mdx
  • docs/content/docs/java/api-reference/queue/events.mdx
  • docs/content/docs/java/api-reference/queue/index.mdx
  • docs/content/docs/java/api-reference/queue/jobs.mdx
  • docs/content/docs/java/api-reference/queue/meta.json
  • docs/content/docs/java/api-reference/queue/pubsub.mdx
  • docs/content/docs/java/api-reference/queue/queues.mdx
  • docs/content/docs/java/api-reference/queue/resources.mdx
  • docs/content/docs/java/api-reference/queue/workers.mdx
  • docs/content/docs/node/api-reference/queue.mdx
  • docs/content/docs/node/api-reference/queue/events.mdx
  • docs/content/docs/node/api-reference/queue/index.mdx
  • docs/content/docs/node/api-reference/queue/jobs.mdx
  • docs/content/docs/node/api-reference/queue/meta.json
  • docs/content/docs/node/api-reference/queue/pubsub.mdx
  • docs/content/docs/node/api-reference/queue/queues.mdx
  • docs/content/docs/node/api-reference/queue/resources.mdx
  • docs/content/docs/node/api-reference/queue/workers.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/node-java-queue-split

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the docs label Jul 12, 2026
@pratyush618
pratyush618 force-pushed the docs/node-java-queue-split branch from f96b9fe to 20a4b94 Compare July 12, 2026 11:31
@pratyush618
pratyush618 merged commit f77e589 into master Jul 12, 2026
14 checks passed
@pratyush618
pratyush618 deleted the docs/node-java-queue-split branch July 12, 2026 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant