Add repo conventions and cron documentation

This commit is contained in:
2026-03-28 00:17:57 +00:00
parent f1aeaeefb5
commit 1b339d5bce
7 changed files with 279 additions and 0 deletions

30
cron/README.md Normal file
View File

@@ -0,0 +1,30 @@
# Cron / Automation
This directory documents recurring jobs and their schedules.
Goal: make it obvious what runs, when it runs, why it exists, and what script/skill it depends on.
## Layout
- `*.md` — one file per recurring job
- each file should record:
- job name
- purpose
- schedule
- entrypoint command/script
- dependencies
- expected output/behavior
- notes on state or alerting
## Current documented jobs
- `daily-overview.md`
- `github-notifications.md`
- `capmetro-monitor.md`
- `gmail-unread-poll.md`
## Notes
This folder is documentation-first.
It does not need to mirror the exact runtime scheduler format as long as it clearly explains the active pattern and entrypoints.

31
cron/capmetro-monitor.md Normal file
View File

@@ -0,0 +1,31 @@
# CapMetro Monitor
## Purpose
Watch for CapMetro service changes relevant to Ben's commute, especially Route 5 and MetroRail-related monitoring assets.
## Entrypoints
- Skill: `skills/capmetro-monitor/`
- Primary monitor: `skills/capmetro-monitor/scripts/monitor.sh`
- Change check: `skills/capmetro-monitor/scripts/check-changes.sh`
- Route status helper: `skills/capmetro-monitor/scripts/route5-status.sh`
- Additional watch scripts:
- `skills/capmetro-monitor/scripts/watch-departure.sh`
- `skills/capmetro-monitor/scripts/watch-departure-v2.sh`
- `skills/capmetro-monitor/scripts/monitor-route5.js`
## Schedule
- Recurring
- Exact active runtime schedule should be recorded here when finalized
## Expected behavior
- Checks for service changes and commute-relevant updates
- Translates transit-operator language into plain English summaries
- Supports route/status-specific helper workflows
## Notes
Prefer GTFS-driven or documented skill behavior over ad hoc scraping where possible. If the operational entrypoint changes, update this doc.

34
cron/daily-overview.md Normal file
View File

@@ -0,0 +1,34 @@
# Daily Overview Reminder
## Purpose
Provide a daily operational overview that summarizes:
- open projects
- pending reminders
- yesterday summary
- behavioral rules pending review
## Trigger
- Scheduled reminder / automation
- Current reminder text requests reading `memory/behavior-rules-pending.md` before the behavioral-rules section
## Inputs
- `state/projects.json`
- reminder/runtime state if present
- `memory/YYYY-MM-DD.md`
- `memory/behavior-rules-pending.md`
## Expected behavior
- Summarize open projects
- Report pending reminders, if any
- Summarize the prior day
- Review pending behavioral rules
- Add an Approval Queue with `Approve / Reject?` per candidate rule
- If none exist, explicitly say: `No pending candidate rules.`
## Notes
This job mixes tracked code/docs with untracked local memory/state. The implementation should rely on local runtime files without committing those files to git.

View File

@@ -0,0 +1,33 @@
# GitHub Notifications Check
## Purpose
Review GitHub notifications for PR activity and major releases, with filtering to reduce noise.
## Entrypoint
- Skill: `skills/github-notifications/`
- Main wrapper: `skills/github-notifications/scripts/cron-wrapper.sh`
- Check script: `skills/github-notifications/scripts/check.sh`
- Optional dismissal helper: `skills/github-notifications/scripts/auto-dismiss.sh`
## Schedule
- Recurring
- Exact active schedule should be recorded here when finalized in the runtime scheduler
## Expected behavior
- Checks notification state
- Surfaces relevant PR activity
- Highlights major releases and selected dev builds
- Uses local state to avoid duplicate alerts
## State
- Local generated state file is ignored from git
- Current ignored file pattern: `skills/**/state.json`
## Notes
If runtime behavior changes, update this file alongside the skill or wrapper changes.

24
cron/gmail-unread-poll.md Normal file
View File

@@ -0,0 +1,24 @@
# Gmail Unread Poll
## Purpose
Poll unread Gmail state for triage/review workflows.
## Entrypoint
- Script: `scripts/gmail-unread-poll.sh`
## Schedule
- Recurring or ad hoc, depending on how the scheduler is configured
- Record the exact active schedule here if it becomes a standing job
## Expected behavior
- Checks unread Gmail state
- Supports lightweight inbox monitoring/triage workflows
- May feed reminder or review flows depending on runtime usage
## Notes
Do not commit mailbox contents, auth artifacts, or generated local state.