[codex] Replace stale project plan with implementation docs#196
Conversation
Remove the outdated PROJECT.md planning document and replace it with focused implementation references under docs/. Document current app discovery, route/layout handling, server handlers, resources, API dispatch, view/RSC transport, Vite build behavior, deployment, and error handling. Add docs consistency coverage to prevent removed APIs and plugin options from being reintroduced as current guidance.
Greptile SummaryThis PR replaces the stale
Confidence Score: 5/5Pure documentation and test change with no production code modifications — safe to merge. All changed files are Markdown docs, test helpers, and test suites. No runtime or library code is touched. The new tests actively prevent both regression to removed APIs and re-introduction of the stale plan, and both previously open review threads are now resolved in the docs themselves. No files require special attention.
|
| Filename | Overview |
|---|---|
| docs/server-handlers.md | New doc covering route loaders/actions, resources (with explicit note that component is required), API routes, input parsers, and middleware — addresses both issues flagged in the previous review round |
| docs/app-and-route-discovery.md | New doc covering explicit app registration, routes/layouts, filesystem discovery globs, manifests, and matching |
| docs/runtime-deployment-and-errors.md | New doc covering request dispatch order, internal request validation hook, result helpers, redirect/invalid defaults, and error vs fault handling |
| tests/helpers/read-doc.ts | New shared helper that extracts the readDoc utility previously duplicated across test files |
| tests/implementation-docs.test.ts | New test suite that asserts PROJECT.md is gone, all new docs exist, key API names are present, and removed APIs are not re-introduced |
| tests/docs-package-names.test.ts | Updated to import readDoc from the shared helper and to check the new implementation docs instead of the deleted PROJECT.md |
Reviews (2): Last reviewed commit: "docs: address implementation review feed..." | Re-trigger Greptile
Clarify current resource component requirements and middleware input ordering in the implementation docs. Extract the duplicated docs test file reader into a shared helper used by the implementation and package-name docs tests.
Summary
Closes #189.
This removes the stale
PROJECT.mdplanning document and replaces it with focused implementation docs underdocs/for future contributors.The new docs cover:
view(...)responses, React Server Components, Flight transport, and client/server boundariesWhy
PROJECT.mddescribed older v1 planning scope and removed configuration/API concepts. Keeping it as a single large plan made it easy for contributor guidance to drift from the current public API and implementation.Validation
bun test tests/implementation-docs.test.ts tests/docs-package-names.test.tsbun fmtbun lint:fixbun testbun typecheckbun run buildChangeset
Included
.changeset/quiet-cameras-reflect.mddocumenting the docs replacement.