Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions workspace_templates/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ This ensures:

### Worker Usage Principles

1. Use workers for EXTERNAL operations (network, external APIs)
1. Use workers for external operations (network, external APIs)
2. Use workers for long-running or async tasks
3. Prefer small, testable tasks with clear acceptance criteria
4. After worker completion, record key outcomes in daily memory
5. On worker failure, capture cause and mitigation in memory/canon when relevant
6. NEVER delegate LOCAL operations to workers — do them directly
6. Do not delegate local operations to workers. Do them directly.
7. Prefer to create one worker for one specific task or interaction with a specific service. Do not duplicate functionality, do not duplicate workers, change them if needed.
8. Workers may use `fs_read` and `fs_write` inside their own temporary worker workspace.
9. Workers do not automatically get access to the Octo main workspace. If a worker needs specific workspace files, pass the smallest necessary `allowed_paths`.
Expand All @@ -72,7 +72,7 @@ You wake up fresh each session. Persist important continuity to files:
- **Long-term summary**: `MEMORY.md`
- **Canonical memory**: `memory/canon/facts.md`, `memory/canon/decisions.md`, `memory/canon/failures.md`

If you need to remember something, write it down.
If something will matter later, write it down.

## Context Reset Protocol

Expand Down Expand Up @@ -129,7 +129,7 @@ Reset artifacts (read/write):
- `AGENTS.md` (this file): operating instructions
- `USER.md`: user preferences and identity context
- `SOUL.md`: persona and communication style
- `HEARTBEAT.md`: scheduled checks and proactive tasks
- `HEARTBEAT.md`: readable scheduler snapshot for scheduled checks and proactive tasks
- `MEMORY.md`: long-term notes

## Troubleshooting Protocol
Expand All @@ -140,7 +140,7 @@ Before concluding that something is broken or impossible:

1. Check documentation first.
2. List at least a couple of alternative paths.
3. Ask what a careful human operator would try next.
3. Consider what a careful human operator would try next.

Self-audit question:

Expand Down
14 changes: 9 additions & 5 deletions workspace_templates/HEARTBEAT.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# HEARTBEAT - Scheduled Tasks

This file defines recurring checks and proactive tasks.
This file reflects recurring checks and proactive tasks configured in the scheduler.
It is primarily a readable snapshot, not the source of truth.
Keep entries concrete, bounded, and easy to verify.
It is a living document and may be edited freely as schedules and routines change.
Scheduler changes may rewrite this file.

## How To Use

- Each task should have a stable ID.
- Say what should run, how often, and what output is expected.
- Define or update schedules through scheduler tools or commands, then use this file to review the current state.
- Say what should run, how often, what output is expected, and whether the user should be notified.
- Prefer writing results to workspace files instead of keeping them only in chat.
- If a task depends on network access, assign an appropriate worker.
- `Daily at HH:MM` uses UTC.
- If nothing is due, return `HEARTBEAT_OK`.

## Task Template
Expand All @@ -18,11 +21,12 @@ It is a living document and may be edited freely as schedules and routines chang
- **ID**: example_task
- **Description**: Brief description of what this task is for
- **Frequency**: Daily at 09:00
- **Notify user**: if_significant
- **Worker**: web_researcher
- **Task**: [Scheduled: example_task] Do the bounded recurring work and save results to an agreed file
- **Last execution**: never
- **Last execution**: Never
- **Status**: Disabled

## Tracking

- example_task_last_run: never
- example_task_last_run: Never
2 changes: 1 addition & 1 deletion workspace_templates/MEMORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Keep it compact and high-signal.
## What Belongs Here

- Durable project goals and operating assumptions
- Stable user preferences and collaboration style
- Shared working assumptions that matter across sessions
- Important systems context that is costly to rediscover
- Ongoing initiatives worth remembering across days

Expand Down
1 change: 1 addition & 0 deletions workspace_templates/USER.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Use this file for durable user-specific context.
Only put things here that are stable and useful across many sessions.
It is a living document and may be edited freely as you learn more about the user.
Prefer user-specific facts here. Put broader project context in `MEMORY.md`.

## Good Examples

Expand Down
14 changes: 14 additions & 0 deletions workspace_templates/memory/canon/decisions.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
# Decisions

Important decisions, policies, and standing rules.
This file is injected into the Octo context, so keep it lean and high-signal.

Suggested format:
## Decision
- Decision: what was chosen
- Why: short rationale
- Since: optional date or milestone

Avoid:
- Repeating raw discussion history
- Temporary experiments
- Low-confidence ideas that have not been adopted

12 changes: 12 additions & 0 deletions workspace_templates/memory/canon/facts.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# Facts

Verified facts that are likely to stay useful over time.
Keep entries short, specific, and easy to scan.

Suggested format:
- Subject: fact
- Subject: fact

Avoid:
- Tentative guesses
- Long narratives
- Things that belong in decisions or failures

14 changes: 14 additions & 0 deletions workspace_templates/memory/canon/failures.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
# Failures

Lessons from meaningful mistakes, regressions, or repeated dead ends.
This file is injected into the Octo context, so prefer concise patterns over long incident reports.

Suggested format:
## Failure
- What failed: short description
- Why it failed: root cause if known
- Guardrail: what to do differently next time

Avoid:
- One-off noise without a lesson
- Blame without evidence
- Full logs or raw transcripts