Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add cron vs heartbeat decision guide [AI-assisted] #1533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
JustYannicc wants to merge 1 commit into from
Closed

docs: add cron vs heartbeat decision guide [AI-assisted] #1533

JustYannicc wants to merge 1 commit into from

Conversation

@JustYannicc
Copy link
Contributor

@JustYannicc JustYannicc commented Jan 23, 2026 •
edited
Loading

Summary

Adds comprehensive documentation to help users decide between heartbeat and cron jobs for automation tasks.

Closes #1532

Changes

New documentation

  • docs/automation/cron-vs-heartbeat.md - Complete decision guide (~280 lines) with:
    • Quick decision table for common use cases
    • Detailed guidance on when to use each mechanism
    • Decision flowchart
    • Cost considerations
    • Examples combining both approaches

Cross-references added

  • docs/automation/cron-jobs.md - Link to new guide
  • docs/gateway/heartbeat.md - Link to new guide
  • docs/start/hubs.md - Discovery link

Navigation

  • docs/docs.json - Sidebar and redirect entries

Template update

  • docs/reference/templates/AGENTS.md - Brief "when to use each" guidance (injected as project context)

Notes

  • Docs only - no code or system prompt changes
  • The AGENTS.md snippet provides brief guidance that the agent sees as project context
  • Full guide is for users configuring their automation

AI Contribution Disclosure

  • AI-assisted: Generated with Claude (Clawdbot sub-agent)
  • Testing level: Lightly tested - docs build verified, content reviewed
  • Understanding: Yes, this is straightforward documentation adding decision guidance for existing features

No code changes, so no runtime testing needed.

@JustYannicc JustYannicc changed the title docs: add cron vs heartbeat decision guide docs: add cron vs heartbeat decision guide [AI-assisted] Jan 23, 2026
@JustYannicc
docs: add cron vs heartbeat decision guide
f2fb056 
- New docs/automation/cron-vs-heartbeat.md with complete guidance
- Cross-links from heartbeat.md and cron-jobs.md
- Updated AGENTS.md template with practical guidance
- Added navigation entry in docs.json
@JustYannicc JustYannicc force-pushed the feature/cron-heartbeat-guidance branch from aae1d36 to f2fb056 Compare January 23, 2026 20:13
@steipete
Copy link
Contributor

steipete commented Jan 24, 2026

Thank you, this is great!

@steipete steipete self-assigned this Jan 24, 2026
@steipete
Copy link
Contributor

steipete commented Jan 24, 2026

Landed on main with:

  • e882f7d docs: add cron vs heartbeat decision guide (rebased)
  • f938f66 docs: extend cron vs heartbeat guide (Lobster section, delivery/cost clarifications, changelog + clawtributors)

Tests:

  • pnpm lint ✅
  • pnpm build ✅
  • pnpm test ❌ (src/infra/tailscale.test.ts expects tailscale but environment resolved /opt/homebrew/bin/tailscale)

@steipete
Copy link
Contributor

steipete commented Jan 24, 2026

Closed: changes landed on main via e882f7d + f938f66.

@steipete steipete closed this Jan 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@steipete steipete

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature]: Add cron vs heartbeat decision guide

2 participants

@JustYannicc @steipete