Skip to content

docs: replace PLAN.md design record with generic AGENTS.md - #3

Merged
jkyberneees merged 2 commits into
mainfrom
feat/agents-md
Sep 4, 2026
Merged

docs: replace PLAN.md design record with generic AGENTS.md#3
jkyberneees merged 2 commits into
mainfrom
feat/agents-md

Conversation

@jkyberneees

Copy link
Copy Markdown
Contributor

Summary

  • PLAN.md deleted per request. Its unique content — architecture map, the seven invariants, translation hard edges, testing conventions, odek migration path — is folded into the new AGENTS.md, so nothing is lost from the repo (full original preserved in the v0.1.0 tag).
  • AGENTS.md (generic, tool-agnostic): commands, architecture table, invariants that must not break, testing conventions (RED-first, timing knobs, e2e build tag), repo flow (feat/|fix/ → PR → CI green → squash).
  • README's design-record section now points at AGENTS.md.
  • .gitignore: .env ignored (plus scratch dirs).

Docs-only change — no code touched.

- PLAN.md removed (design record preserved in history; essential content —
  architecture map, invariants, translation hard edges, odek migration
  path — folded into AGENTS.md)
- AGENTS.md: tool-agnostic guidance for AI agents and humans — commands,
  architecture, the seven invariants that must not break, testing
  conventions (RED-first, timing knobs, e2e build tag), repo flow
  (feat/|fix/ -> PR -> CI green -> squash)
- README design-record section now points at AGENTS.md
@jkyberneees
jkyberneees merged commit ac64cbc into main Sep 4, 2026
4 checks passed
@jkyberneees
jkyberneees deleted the feat/agents-md branch September 4, 2026 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant