{
"meta": {
"agent": "planner",
"task_id": "676",
"title": "Add README.md to project root",
"created_at": "2026-04-13T00:00:00Z"
},
"inputs": [
{
"name": "issue-676",
"type": "context",
"ref": "AgentSDE/agent-core-artefacts#676",
"notes": "Add comprehensive README.md to repo root"
},
{
"name": "CLAUDE.md",
"type": "file",
"ref": "CLAUDE.md",
"notes": "Contains repo purpose, directory structure, naming conventions — primary content source"
},
{
"name": "existing-README",
"type": "file",
"ref": "README.md",
"notes": "Current one-liner placeholder to be replaced"
}
],
"outputs": [
{
"name": "plan.md",
"type": "plan",
"format": "md",
"content": "Implementation plan for README.md"
}
],
"files": [
{
"path": "README.md",
"action": "modify",
"reason": "Replace one-line placeholder with comprehensive documentation"
}
],
"steps": [
{
"id": "S1",
"summary": "Rewrite README.md with repo purpose, directory structure, naming conventions, and usage notes",
"acceptance": [
"README.md exists at repo root and is >20 lines",
"Covers repository purpose and high-level overview",
"Documents directory structure and contents/role of each top-level directory",
"Written in clear, concise English suitable for human engineers and autonomous agents"
],
"depends_on": []
}
],
"risks": [
{
"risk": "Directory structure in README may drift from actual layout",
"mitigation": "Acceptable per issue scope — manually maintained document"
}
],
"assumptions": [
"Existing one-line README.md should be overwritten with new content",
"Content derived from CLAUDE.md is authoritative for structure documentation"
],
"open_questions": []
}