Task Plans
August 26, 2026 ยท View on GitHub
Use this directory for planning, progress notes, and handoff material for substantial SURF work.
Create one task directory per effort:
docs/plans/<task-name>/
Use short kebab-case names, for example coaxpress-link-debug or axi-stream-resize-tests.
Each task directory should capture:
- Goal and scope.
- Current status.
- Important design or debugging decisions.
- Files, modules, or tests involved.
- Validation already run.
- Open risks, blockers, and next steps.
Keep notes concise and factual. Do not store large simulator logs, generated outputs, build products, or waveform files here; summarize them and link to durable locations when needed.
Before merging completed work, move enduring usage, methodology, and maintenance guidance into the nearest permanent README. Remove the completed task directory unless it still serves as an intentional design record or an active follow-up handoff.