Skip to content

docs: improve bulk actions docs#4211

Merged
carderne merged 2 commits into
mainfrom
docs/bulk-actions-sdk-docs
Jul 10, 2026
Merged

docs: improve bulk actions docs#4211
carderne merged 2 commits into
mainfrom
docs/bulk-actions-sdk-docs

Conversation

@carderne

@carderne carderne commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator
  • Combine SDK and dashboard bulk actions docs
  • Fix API reference pages for bulk actions
  • Fix weird rendering on bulk actions page

Todo

  • not sure about having the SDK+dashboard combined and under "Using the dashboard"... need to find the right place

@changeset-bot

changeset-bot Bot commented Jul 9, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 93975a0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 23dc8305-5843-4f23-aa6f-9184762e836e

📥 Commits

Reviewing files that changed from the base of the PR and between abd4478 and 93975a0.

📒 Files selected for processing (5)
  • docs/bulk-actions.mdx
  • docs/docs.json
  • docs/errors-retrying.mdx
  • docs/runs/bulk-actions.mdx
  • docs/v3-openapi.yaml
✅ Files skipped from review due to trivial changes (1)
  • docs/errors-retrying.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/v3-openapi.yaml
📜 Recent review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: code-quality / code-quality
  • GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/docs.json

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/docs.json: Main documentation config must be defined in docs.json which includes navigation structure, theme, and metadata
Navigation structure in docs.json should be organized using navigation.dropdowns with groups and pages

Files:

  • docs/docs.json
docs/**/*.mdx

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from @trigger.dev/sdk in code examples (never from @trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences: typescript, bash, json

Files:

  • docs/bulk-actions.mdx
  • docs/runs/bulk-actions.mdx
🧠 Learnings (2)
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.

Applied to files:

  • docs/bulk-actions.mdx
  • docs/runs/bulk-actions.mdx
📚 Learning: 2026-04-30T20:30:29.458Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3226
File: docs/ai-chat/quick-start.mdx:13-13
Timestamp: 2026-04-30T20:30:29.458Z
Learning: In this repo’s documentation MDX files (`docs/**/*.mdx`), use `ts` and `tsx` (not `typescript`) as the code-fence language tags for TypeScript/TSX snippets. Do not flag `ts`/`tsx` code-fence language tags as incorrect in any docs MDX file, since this is the site-wide Mintlify-compatible convention.

Applied to files:

  • docs/bulk-actions.mdx
  • docs/runs/bulk-actions.mdx
🪛 LanguageTool
docs/runs/bulk-actions.mdx

[grammar] ~10-~10: Ensure spelling is correct
Context: ...r abort pending work. ## Create a bulk replay Use runs.bulk.replay() to replay every...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (4)
docs/bulk-actions.mdx (1)

3-12: LGTM!

Also applies to: 25-54, 55-76

docs/runs/bulk-actions.mdx (2)

1-16: LGTM!

Also applies to: 31-48, 53-66, 68-119, 121-145, 147-173, 175-182


17-29: 🎯 Functional Correctness

Confirm targetRegion and bulk action field types match the SDK/OpenAPI schema.

docs/docs.json (1)

80-81: LGTM!

Also applies to: 341-343, 351-359, 763-766


Walkthrough

Adds bulk action API endpoints and schemas for listing, creating, retrieving, and aborting asynchronous cancel or replay operations. Updates dashboard and SDK guides with filtering, polling, cancellation, and API reference details. Adds endpoint-specific management pages, revises documentation navigation, and redirects the previous bulk-actions URL.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is too incomplete for the template; it omits the issue link, checklist, testing steps, changelog, and screenshots. Add the missing template sections: Closes #issue, checklist, Testing, Changelog, and Screenshots, with specific test steps and a short summary.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and matches the PR’s main focus on bulk actions documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/bulk-actions-sdk-docs

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.

❤️ Share

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

coderabbitai[bot]

This comment was marked as resolved.

@matt-aitken matt-aitken marked this pull request as ready for review July 9, 2026 17:39
devin-ai-integration[bot]

This comment was marked as resolved.

@kathiekiwi kathiekiwi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 💟

@carderne carderne enabled auto-merge (squash) July 9, 2026 18:31

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 2 new potential issues.

Open in Devin Review

Comment thread docs/docs.json
Comment thread docs/v3-openapi.yaml
@carderne carderne merged commit b4866f0 into main Jul 10, 2026
19 checks passed
@carderne carderne deleted the docs/bulk-actions-sdk-docs branch July 10, 2026 10:49
@trigger-dot-bot

trigger-dot-bot Bot commented Jul 10, 2026

Copy link
Copy Markdown

Preview Deployment

Status Preview Commit Updated
🟢 Ready docs-bulk-actions-sdk-docs.triggerlabs.dev 93975a0 Jul 10, 10:57 UTC

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.

2 participants