AI Agents SDE Task Viewer
      • Context
      • Plan
      • Prd
  1. Home
  2. AgentSDE
  3. agent-core-artefacts
  4. gh-676
  5. plan
  6. plan.md
plan.md(1.1 KB)· Apr 13, 2026· 1 min read
  • Summary
  • Files
  • Steps
  • Verification
  • Risks

Plan — Add README.md to project root (#676)#

Summary#

Replace the existing one-line README.md with a comprehensive document covering the repository's purpose, directory structure, naming conventions, and usage. Content is largely derived from CLAUDE.md but rewritten for a README audience (engineers and agents discovering the repo for the first time).

Files#

FileActionDescription
README.mdmodifyReplace placeholder with full documentation

Steps#

  1. Rewrite README.md — Replace the current one-liner with structured content: repo purpose/overview, directory structure tree (matching CLAUDE.md), naming conventions for task directories, and a note that this repo has no build system or runtime.

Verification#

  • README.md exists at the repo root and is non-trivial (>20 lines)
  • Covers: purpose, directory structure, naming conventions
  • Written in clear, concise English suitable for human engineers and autonomous agents

Risks#

  • Directory structure in README may drift from actual layout over time — acceptable per issue scope (manually maintained).
ContextPrd