Skip to content

docs: align API and planning references with current implementation#31

Draft
cursor[bot] wants to merge 1 commit intomainfrom
cursor/documentation-automation-system-707c
Draft

docs: align API and planning references with current implementation#31
cursor[bot] wants to merge 1 commit intomainfrom
cursor/documentation-automation-system-707c

Conversation

@cursor
Copy link
Copy Markdown
Contributor

@cursor cursor bot commented Apr 13, 2026

Summary

Updates technical docs to match currently implemented API behavior and developer workflows.

Docs added/updated

  • docs/reference/api-endpoints.md
    • Added planning chat endpoints (/chat, /chat/stream) with mode semantics and payload constraints.
    • Added actions dry-run endpoint (/actions/preview).
    • Added memory endpoint (/memory) with storage paths and purpose.
    • Added card finalize/build-output endpoints (GET/POST /cards/[cardId]/finalize, /produced-files, /push).
    • Expanded orchestration coverage with run/assignment/check/webhook routes.
    • Added docs API (GET /api/docs).
    • Clarified as-built DB constraint: SQLite is implemented; Postgres adapter not yet implemented.
  • docs/domains/planning-reference.md
    • Corrected per-card finalize workflow to actual GET finalize package + POST finalize SSE flow.
    • Documented finalize preconditions enforced by route handlers.
    • Removed stale finalize/confirm path.
  • docs/development-reference.md
    • Updated ~/.dossier/ruvector from future state to active memory-plane storage.
    • Added memory inspection pointers (GET /api/projects/<projectId>/memory and memory domain reference).
  • docs/reference/configuration-reference.md
    • Clarified DB_DRIVER support and explicitly documented current Postgres limitation.

Codepaths covered

  • Planning/chat:
    • app/api/projects/[projectId]/chat/route.ts
    • app/api/projects/[projectId]/chat/stream/route.ts
  • Card finalize/memory/build outputs:
    • app/api/projects/[projectId]/cards/[cardId]/finalize/route.ts
    • app/api/projects/[projectId]/cards/[cardId]/produced-files/route.ts
    • app/api/projects/[projectId]/cards/[cardId]/push/route.ts
    • app/api/projects/[projectId]/memory/route.ts
  • Action preview:
    • app/api/projects/[projectId]/actions/preview/route.ts
  • Orchestration lifecycle:
    • app/api/projects/[projectId]/orchestration/**/route.ts
  • Docs API:
    • app/api/docs/route.ts
  • DB adapter behavior:
    • lib/db/index.ts

Key knowledge gaps addressed

  • Missing API docs for several active endpoints (chat stream modes, finalize SSE, memory, orchestration run/check lifecycle, docs API).
  • Stale finalize contract in planning domain docs (finalize/confirm no longer reflects implementation).
  • Contradictory DB configuration guidance around Postgres support.
  • Outdated developer data-directory note for RuVector/memory storage.

Validation

  • npm run test executed after dependency install; failed due to existing environment/native-binding issues (better-sqlite3/repo test setup), unrelated to docs-only changes.
  • npm run type-check is not defined in this repository’s package.json (script missing).
Open in Web View Automation 

Co-authored-by: rwliebs <rwliebs@users.noreply.github.com>
@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Apr 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
v0-ai-orchestration-interface Ready Ready Preview, Comment, Open in v0 Apr 13, 2026 4:14pm

Request Review

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