Skip to content

docs: add shared guide content#422

Merged
pratyush618 merged 12 commits into
masterfrom
docs/parity-shared-guides
Jul 12, 2026
Merged

docs: add shared guide content#422
pratyush618 merged 12 commits into
masterfrom
docs/parity-shared-guides

Conversation

@pratyush618

Copy link
Copy Markdown
Collaborator

Second slice of the docs SDK-parity work: fill the Python-only holes in the shared guide tree so Node and Java readers get the same content — real ported examples where the feature ships, honest callouts where it doesn't. Every ported API verified against SDK source. 12 commits.

Core guides

  • tasks: unified "Defining a task" example; ported task naming to Node/Java; callouts for expires / direct-call / per-task-middleware / per-task-serializer (all feature-absent in Node/Java).
  • queues: queue-level defaults — Node callout (per-task only), Java per-task descriptor.
  • workers: worker tags + lifecycle events — feature-absent in Node/Java, now honest callouts.
  • predicates: Node + Java worked examples; DSL/persistence/metrics gap callouts.

Workflow guides

  • canvas: chunks/starmap → Node/Java group-build snippets; canvas-vs-DAG notes.
  • saga: continue-mode compensation + events — Node/Java callouts.
  • gates: gate conditions + events — Node/Java callouts.

Reliability / extensibility / integrations

  • serializers: Node + Java serializer-selection matrix.
  • prometheus: real Java Micrometer→Prometheus section (was a 2-line stub).
  • retries: Node custom-backoff block.
  • guarantees: Java idempotency example fixed to show real dedup.

Also

  • fix: stop decimal ::marker overlapping the .flowsteps step badges (Architecture → Mesh) — scoped the decimal-list rule to .article ol:not(.flowsteps).

Parity gate, typecheck, and static build all pass.

@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: 59 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: 3a68ae98-f30e-49d7-949c-f663fa6832b5

📥 Commits

Reviewing files that changed from the base of the PR and between 420a62d and f8f7762.

📒 Files selected for processing (12)
  • docs/app/styles/docs.css
  • docs/content/docs/shared/guides/core/predicates.mdx
  • docs/content/docs/shared/guides/core/queues.mdx
  • docs/content/docs/shared/guides/core/tasks.mdx
  • docs/content/docs/shared/guides/core/workers.mdx
  • docs/content/docs/shared/guides/extensibility/serializers.mdx
  • docs/content/docs/shared/guides/integrations/prometheus.mdx
  • docs/content/docs/shared/guides/reliability/guarantees.mdx
  • docs/content/docs/shared/guides/reliability/retries.mdx
  • docs/content/docs/shared/guides/workflows/canvas.mdx
  • docs/content/docs/shared/guides/workflows/gates.mdx
  • docs/content/docs/shared/guides/workflows/saga.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/parity-shared-guides

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

@github-actions github-actions Bot added the docs label Jul 12, 2026
@pratyush618 pratyush618 changed the title docs: SDK parity 2 — shared guide content docs: add shared guide content Jul 12, 2026
@pratyush618
pratyush618 merged commit fe0c249 into master Jul 12, 2026
14 of 15 checks passed
@pratyush618
pratyush618 deleted the docs/parity-shared-guides branch July 12, 2026 16: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