HEARTBEAT.mddevelopmentOpenclawv1.0.0

Docs Freshness Checker

Checks if documentation is outdated by comparing doc dates with code changes.

Setup time: ~5 min
Model: Haiku
Cost: ~$0.10/day Calculate your exact cost at Clawback
Last updated: Mar 16, 2026
byRunbooks Communitycontributor

Template

HEARTBEAT.md
Every Monday at 10am:
1. List all markdown files in the docs directory:
   gh api repos/{owner}/{repo}/git/trees/main?recursive=1 --jq '.tree[] | select(.path | endswith(".md"))'
2. For each doc file, get last modified date:
   gh api repos/{owner}/{repo}/commits?path={file}&per_page=1 --jq '.[0].commit.committer.date'
3. For related source files, get last modified date
4. Flag docs not updated in 90+ days: "Stale doc: {file} (last updated {date})"
5. Flag docs where related source code changed after doc was last updated
6. Weekly report: total docs, fresh count, stale count, files needing review
7. Create GitHub issues for critically stale docs (180+ days)

Setup

  1. 1

    Copy the HEARTBEAT.md content below into your OpenClaw workspace at `~/.openclaw/workspace/HEARTBEAT.md`.

  2. 2

    Install the required skills: `clawhub install github`, `clawhub install message`.

  3. 3

    Open your agent channel (Telegram or any connected channel) and send a message to confirm it's running.

  4. 4

    Your agent will follow the schedule in HEARTBEAT.md automatically. Check back in 30 minutes to see it in action.

  5. 5

    Customize the template: adjust timing, thresholds, and notification targets to fit your setup.

Tip: The template uses placeholder values like {your brand} or {repo}. Replace these with your actual values before saving.

Install commands

Save the template to your OpenClaw workspace, then install the required skills.

# 1. Save the template
cp <download> ~/.openclaw/workspace/HEARTBEAT.md

# 2. Install skills
clawhub install github
clawhub install message

Version History

v1.0.0Initial releaseMar 16, 2026

Framework

Openclaw

Skills required

github →message →

Estimated cost

~$0.10/day

on Haiku model

Calculate your exact cost at Clawback

File type

HEARTBEAT.md

Defines scheduled tasks. Runs on a heartbeat interval.

Version

v1.0.0

Updated Mar 16, 2026

Contributor

Runbooks Community →

Community submission

Spending too much?

Track and optimize your agent API costs.

Try Clawback →

You might also like

HEARTBEAT.md

GitHub PR Reviewer

Auto-review new PRs during business hours. Post summaries, flag issues.

~$0.50/day · ~5 min setup

HEARTBEAT.md

CI Monitor

Watch GitHub Actions. Alert on failures with the relevant logs.

~$0.20/day · ~3 min setup

HEARTBEAT.md

Deploy Tracker

Track deployments across repos. Daily changelog of what shipped.

~$0.15/day · ~5 min setup

← Back to all runbooks