docs: add heartbeat example (partial #179) - #240
Merged
TerrysPOV merged 1 commit intoJun 28, 2026
Conversation
Copy-paste settings snippet and setup notes for the heartbeat feature. Partial fix for moazbuilds#179 (heartbeat slice only). Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Author
|
Note on the failing The check shows as SUCCESS in the rollup because the workflow exits 0 on auth failure — but mergeStateStatus is UNSTABLE. This is a repo-side secret configuration issue, not a problem with the PR code. Happy to address any actual code feedback. |
TerrysPOV
approved these changes
Jun 28, 2026
TerrysPOV
left a comment
TerrysPOV
left a comment
Collaborator
There was a problem hiding this comment.
Docs match the implementation — verified config keys (enabled, interval, prompt, forwardToTelegram, excludeWindows) against src/config.ts, the prompt path and log directory against src/commands/start.ts and src/runner.ts, and the CLI invocations against src/index.ts. Clean addition.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Partial fix for #179 — heartbeat slice only.
Adds
examples/heartbeat/README.mdwith a copy-pastesettings.jsonsnippet, prompt override path, and daemon start/status notes. Matches the scoped approach discussed on the issue (one directory per feature; more slices can follow in separate PRs).Test plan
Made with Cursor