Skip to content

Commit 708bebc

Browse files
lukeclaude
andcommitted
docs: add workflow notes for agent task document creation
Document the correct workflow to ensure agent task documents are available in agent workspaces. Task docs must be committed to main before creating the agent workspace. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a5eb5a4 commit 708bebc

1 file changed

Lines changed: 38 additions & 1 deletion

File tree

docs/agents/README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,4 +348,41 @@ Here's a template that works well:
348348
4. **Concrete > Abstract**: Specific file paths, exact commands
349349
5. **Testable > Theoretical**: Include ways to verify success
350350

351-
Remember: A well-written task document should enable an agent to start coding within minutes, not spend hours figuring out what to do.
351+
Remember: A well-written task document should enable an agent to start coding within minutes, not spend hours figuring out what to do.
352+
353+
## Important Workflow Notes
354+
355+
### Creating Agent Task Documents
356+
357+
When creating task documents for agents, follow this workflow to ensure they're available in the agent's workspace:
358+
359+
1. **Create the task document on main branch**
360+
2. **Commit and push to main BEFORE opening the agent**
361+
3. **Then create the agent workspace**
362+
363+
**❌ Common Mistake**: Creating the task document after the agent workspace exists means the agent won't have access to it.
364+
365+
**✅ Correct Workflow**:
366+
```bash
367+
# 1. On main branch, create the task document
368+
cat > docs/agents/AGENT_N_TASK.md << 'EOF'
369+
# Task content...
370+
EOF
371+
372+
# 2. Commit and push
373+
git add docs/agents/AGENT_N_TASK.md
374+
git commit -m "docs: add Agent N task"
375+
git push origin main
376+
377+
# 3. NOW create the agent
378+
./agent start N
379+
```
380+
381+
**If you've already created the agent**, the agent needs to pull from main:
382+
```bash
383+
# Agent will need to run in their workspace:
384+
git fetch origin main
385+
git merge origin main
386+
```
387+
388+
This ensures agents always have access to their task documentation and any other resources committed to main.

0 commit comments

Comments
 (0)