docs: align API and planning references with current implementation#31
Draft
cursor[bot] wants to merge 1 commit intomainfrom
Draft
docs: align API and planning references with current implementation#31cursor[bot] wants to merge 1 commit intomainfrom
cursor[bot] wants to merge 1 commit intomainfrom
Conversation
Co-authored-by: rwliebs <rwliebs@users.noreply.github.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Updates technical docs to match currently implemented API behavior and developer workflows.
Docs added/updated
docs/reference/api-endpoints.md/chat,/chat/stream) with mode semantics and payload constraints./actions/preview)./memory) with storage paths and purpose.GET/POST /cards/[cardId]/finalize,/produced-files,/push).GET /api/docs).docs/domains/planning-reference.mdGET finalize package+POST finalize SSEflow.finalize/confirmpath.docs/development-reference.md~/.dossier/ruvectorfrom future state to active memory-plane storage.GET /api/projects/<projectId>/memoryand memory domain reference).docs/reference/configuration-reference.mdDB_DRIVERsupport and explicitly documented current Postgres limitation.Codepaths covered
app/api/projects/[projectId]/chat/route.tsapp/api/projects/[projectId]/chat/stream/route.tsapp/api/projects/[projectId]/cards/[cardId]/finalize/route.tsapp/api/projects/[projectId]/cards/[cardId]/produced-files/route.tsapp/api/projects/[projectId]/cards/[cardId]/push/route.tsapp/api/projects/[projectId]/memory/route.tsapp/api/projects/[projectId]/actions/preview/route.tsapp/api/projects/[projectId]/orchestration/**/route.tsapp/api/docs/route.tslib/db/index.tsKey knowledge gaps addressed
finalize/confirmno longer reflects implementation).Validation
npm run testexecuted after dependency install; failed due to existing environment/native-binding issues (better-sqlite3/repo test setup), unrelated to docs-only changes.npm run type-checkis not defined in this repository’spackage.json(script missing).