chore: remove stale inception docs PLAN.md and IDEA.md#41
Merged
Conversation
Both files were written at project inception and have not been kept in sync with reality. Nothing in the repo references them (verified with grep across .md/.rs/.toml/.sh/.yml/.yaml). Why they're stale, not historical: - IDEA.md's architecture diagram shows Anthropic and Gemini provider endpoints as first-class boxes, but the server only implements OpenAI and OpenResponses. Its "Future Extensions" list is partly already-done (WebSocket, stats endpoint), partly aspirational (record/replay, Prometheus) — same ideas as PLAN.md's Phase 6. - PLAN.md's Phase 7 "Set up GitHub releases" and "Publish to crates.io" are unchecked, but the project has shipped both (v0.2.x releases, listed on crates.io). Its Technical Decisions Log claims "YAML for config" as decision #3 — already obsoleted by the TOML migration in #37. Several other "unchecked" phases (tool calling, Anthropic, Gemini) are aspirational future work better tracked as GitHub issues than as a stale plan document. Active substitutes are already in place: - Problem statement / "why this exists" -> README.md - Project structure / module org -> specs/architecture.md - API endpoints + capabilities -> specs/api-endpoints.md + specs/responses-api.md - Roadmap / future work -> GitHub issues - Design decisions worth preserving -> code comments per the AGENTS.md guideline "Keep decisions as comments on top of the file" Future agents reading the repo should follow README -> AGENTS.md -> specs/ instead of being pointed at an inception plan that no longer matches the code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Delete
PLAN.mdandIDEA.md— both are stale inception documents that nothing in the repo references and that now actively mislead readers.Why
I read both files end-to-end and grepped the repo for references. Findings:
IDEA.md(104 lines)PLAN.md(342 lines)specs/architecture.mdand the source tree.Cross-repo grep
Nothing links to either file.
Active substitutes are already in place
README.mdspecs/architecture.mdspecs/api-endpoints.md,specs/responses-api.mdHow
git rm PLAN.md IDEA.md. No code changes.Risk
git show HEAD~1:PLAN.mdrecovers it.Checklist