Add known issue for realtime

[ericallam]

Summary by CodeRabbit

• Documentation
  • Updated the Realtime API documentation to include a "Known issues" section, detailing a specific issue with large payloads.
  • Provided a workaround for users to keep payloads below 128KB when using the Realtime API.
  • Added a link to the relevant GitHub issue for tracking purposes.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f954e0f

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]

Walkthrough

The documentation for the Trigger.dev Realtime API has been updated to include a new section on "Known issues." This section addresses a specific problem where the API does not function properly when subscribing to runs with large payloads or outputs stored in an object store. It specifies a workaround of keeping payloads and outputs under 128KB and includes a link to a relevant GitHub issue for further tracking.

Changes

File	Change Summary
docs/realtime/overview.mdx	Added a "Known issues" section detailing a problem with large payloads in the Realtime API and a workaround.

Possibly related PRs

• New runs fundamentals page #1401: The changes in this PR introduce a new documentation page focused on runs, which may relate to the known issues outlined in the main PR regarding the Realtime API's handling of large payloads during runs.

Poem

In the land of code where rabbits hop,
A new section blooms, we can't let it stop!
Known issues are shared, with care and delight,
Keep payloads small, and everything's right!
With links to track, our docs shine so bright,
Hopping through changes, we celebrate tonight! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/realtime/overview.mdx (1)

267-267: Add comma for better readability.

Add a comma after the introductory phrase for improved readability.

-As a workaround you'll need to keep payloads and outputs below 128KB when using the realtime API.
+As a workaround, you'll need to keep payloads and outputs below 128KB when using the realtime API.

🧰 Tools

🪛 LanguageTool

[typographical] ~267-~267: Consider adding a comma after this introductory phrase.
Context: ...gerdotdev/trigger.dev/issues/1451. As a workaround you'll need to keep payloads and output...

(AS_A_NN_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fa18e6c and f954e0f.

📒 Files selected for processing (1)

• docs/realtime/overview.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/realtime/overview.mdx

[typographical] ~267-~267: Consider adding a comma after this introductory phrase.
Context: ...gerdotdev/trigger.dev/issues/1451. As a workaround you'll need to keep payloads and output...

(AS_A_NN_COMMA)

🔇 Additional comments (1)

docs/realtime/overview.mdx (1)

264-267: LGTM! Clear and informative known issues section.

The addition of the known issues section is valuable, providing users with:

• Clear description of the limitation
• Specific size threshold (128KB)
• Link to tracking issue
• Practical workaround

🧰 Tools

🪛 LanguageTool

[typographical] ~267-~267: Consider adding a comma after this introductory phrase.
Context: ...gerdotdev/trigger.dev/issues/1451. As a workaround you'll need to keep payloads and output...

(AS_A_NN_COMMA)