docs: V2 architecture docs, ADR-0007, local dev guide, code generation workflow#810
docs: V2 architecture docs, ADR-0007, local dev guide, code generation workflow#810markturansky wants to merge 1 commit intomainfrom
Conversation
5f4eb42 to
95a6092
Compare
…eneration workflow - docs/internal/architecture/README.md: add V2 REST/PostgreSQL architecture diagrams and component tables alongside V1 legacy docs - docs/internal/adr/0007-rest-api-postgresql-trex-foundation.md: new ADR documenting the decision to adopt rh-trex-ai + PostgreSQL + generated SDKs + Control Plane - docs/internal/developer/local-development/v2-stack.md: end-to-end guide for running the V2 stack locally (DB → API Server → SDK → CLI → Control Plane) - docs/internal/developer/code-generation.md: TRex Kind generator workflow, field types, plugin anatomy, and SDK regeneration pipeline - components/ambient-api-server/README.md: full rewrite with architecture diagram, quick start, plugin system, and environment system - components/ambient-control-plane/README.md: new README covering operating modes, all env vars, package layout, and key behaviors - components/architecture.md: add code generation pipeline diagram and CLI to V2 diagram - docs/internal/deployment/README.md: add V2 component table, secrets config, health checks, and logs for ambient-api-server - docs/internal/adr/README.md: add ADR-0007 to index 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
95a6092 to
c91798b
Compare
Claude Code ReviewSummary PR 810 is a documentation-only change (plus one blank-line deletion in Blocker Issues: None. Critical Issues: None. Major Issues 1. Broken link: runner README points to non-existent directory
Minor Issues 1. ADR index skips ADR-0006
2. Go version inconsistency
3. Stray emoji in headings
Positive Highlights
Recommendations (priority order)
|
Review Queue Status
Action needed: Fix failing CI checks, Resolve merge conflicts
|
|
Closing — the V2 components (api-server, SDK, CLI) need docs but this PR is 7 weeks stale. Will generate fresh documentation from the current codebase state. |
Summary
docs/internal/architecture/README.mdandcomponents/architecture.mdwith Mermaid diagrams covering the full TRex → API → SDK → CLI → Control Plane pipelinedocs/internal/developer/local-development/v2-stack.md: startup sequence, port map, smoke tests, troubleshooting for the full V2 stackdocs/internal/developer/code-generation.md: TRex Kind generator through SDK regen pipelinecomponents/ambient-api-server/README.md; createdcomponents/ambient-control-plane/README.mddocs/internal/deployment/README.mdwith V2 component table, actual ports from manifests, secrets config, and health/log commandsTest plan
docs/internal/adr/README.mdindexambient-api-server-service.yml: 8000/4433/4434)🤖 Generated with Claude Code