chore(docs): heartbeat timeout is now 5 minutes

[ericallam]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 163969e

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 troubleshooting documentation was updated in the “Task run stalled executing” subsection under Runtime issues. The stall heartbeat timeout was changed from 10 minutes to 5 minutes. The 30-second heartbeat interval remains unchanged. No other files or text were modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description Check	❓ Inconclusive	I cannot fully evaluate the PR description because the current PR description text and the repository's required description template were not provided; the raw_summary shows the file change but does not confirm whether the PR body follows the required template or includes sections like motivation, testing, and rollout notes. Without the actual PR description or template I cannot determine completeness against the repo's required structure.	Please provide the PR's current description and the repository's description template or paste the full PR body; alternatively ensure the PR description includes the repository template sections (summary, why the change, testing, rollout/migration notes) and then re-run this check.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "chore(docs): heartbeat timeout is now 5 minutes" accurately and concisely summarizes the primary change (a docs update reducing the stall heartbeat timeout to 5 minutes), follows conventional-commit style, and contains no extraneous detail. It matches the raw_summary change and is clear for reviewers scanning history.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ea-branch-88

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3188dc9 and 163969e.

📒 Files selected for processing (1)

• docs/troubleshooting.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

docs/troubleshooting.mdx (1)

186-186: Clarify "stall heartbeat timeout" wording and quantify missed heartbeats

Tie 5 minutes to 10 consecutive missed heartbeats and use "stall heartbeat timeout" consistently.

-If you see a `TASK_RUN_STALLED_EXECUTING` error it means that we didn't receive a heartbeat from your task before the stall timeout. We automatically heartbeat runs every 30 seconds, and the heartbeat timeout is 5 minutes.
+If you see a `TASK_RUN_STALLED_EXECUTING` error it means we didn't receive a heartbeat from your task before the stall heartbeat timeout. We automatically send a heartbeat every 30 seconds; the timeout is 5 minutes (i.e., 10 consecutive missed heartbeats).

Sweep docs for any lingering "ten minutes" or inconsistent "stall/heartbeat timeout" wording.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}