Skip to content

docs: refresh API references and planning credential guidance#16

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

docs: refresh API references and planning credential guidance#16
cursor[bot] wants to merge 1 commit intomainfrom
cursor/documentation-automation-system-6eab

Conversation

@cursor
Copy link
Copy Markdown
Contributor

@cursor cursor bot commented Mar 30, 2026

Summary

  • Updated documentation to reflect current API surface and runtime behavior.
  • Focused on high-change subsystems: planning auth, orchestration/repo operations, and developer troubleshooting workflows.

Docs updated

  • docs/reference/api-endpoints.md
    • Added missing route groups: setup, GitHub repo endpoints, actions preview, chat/finalize, orchestration lifecycle routes, repo sync/push, docs/memory, and dev restart-and-open utility.
    • Added concrete request/response examples for key endpoints.
  • docs/reference/configuration-reference.md
    • Clarified credential behavior by subsystem.
    • Documented that planning can use Claude CLI paths, while build orchestration still requires ANTHROPIC_API_KEY.
    • Added troubleshooting for common credential/setup failures.
  • docs/domains/planning-reference.md
    • Updated planning flow to include auth/transport paths and corrected finalize flow semantics.
  • docs/domains/api-reference.md
    • Expanded endpoint group index to include orchestration, repo sync/push, setup, docs, and memory routes.
  • docs/development-reference.md
    • Added operational runbook sections for repo sync, card push, and dev restart/open behavior.
    • Added troubleshooting entries aligned with current backend constraints.
  • README.md
    • Aligned top-level credential messaging with actual behavior (planning CLI support vs build API-key requirement).

Codepaths covered

  • Planning credentials and transport:
    • lib/llm/planning-credential.ts
    • lib/llm/claude-client.ts
    • lib/llm/planning-sdk-runner.ts
    • app/api/setup/status/route.ts
  • Orchestration/build/repo endpoints:
    • app/api/projects/[projectId]/orchestration/**
    • app/api/projects/[projectId]/repo/sync/route.ts
    • app/api/projects/[projectId]/cards/[cardId]/push/route.ts
    • lib/orchestration/repo-manager.ts
  • Planning/finalize/API coverage:
    • app/api/projects/[projectId]/chat/route.ts
    • app/api/projects/[projectId]/chat/stream/route.ts
    • app/api/projects/[projectId]/cards/[cardId]/finalize/route.ts
    • app/api/projects/[projectId]/actions/preview/route.ts
  • Developer utility and docs/memory endpoints:
    • app/api/dev/restart-and-open/route.ts
    • app/api/docs/route.ts
    • app/api/projects/[projectId]/memory/route.ts

Validation

  • npm run test executed; failed due to pre-existing repository test failures unrelated to these docs-only changes.
  • npm exec tsc -- --noEmit executed; failed due to pre-existing TypeScript issues unrelated to docs changes.
  • No code behavior changes were introduced in this PR.
Open in Web View Automation 

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

vercel bot commented Mar 30, 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 Mar 30, 2026 4:19pm

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