Skip to content

docs: V2 architecture docs, ADR-0007, local dev guide, code generation workflow#810

Open
markturansky wants to merge 1 commit intomainfrom
docs/ambient-api
Open

docs: V2 architecture docs, ADR-0007, local dev guide, code generation workflow#810
markturansky wants to merge 1 commit intomainfrom
docs/ambient-api

Conversation

@markturansky
Copy link
Contributor

Summary

  • ADR-0007 — documents the decision to adopt rh-trex-ai + PostgreSQL + generated SDKs + Control Plane (deciders: Mark Turansky, Kevin Howell; anchored to the technical evaluation gist from 2026-02-16)
  • V2 architecture diagrams — updated docs/internal/architecture/README.md and components/architecture.md with Mermaid diagrams covering the full TRex → API → SDK → CLI → Control Plane pipeline
  • Local dev guidedocs/internal/developer/local-development/v2-stack.md: startup sequence, port map, smoke tests, troubleshooting for the full V2 stack
  • Code generation workflowdocs/internal/developer/code-generation.md: TRex Kind generator through SDK regen pipeline
  • Component READMEs — rewrote components/ambient-api-server/README.md; created components/ambient-control-plane/README.md
  • Deployment docs — updated docs/internal/deployment/README.md with V2 component table, actual ports from manifests, secrets config, and health/log commands

Test plan

  • Mermaid diagrams render correctly in GitHub
  • All internal links resolve
  • ADR-0007 appears in docs/internal/adr/README.md index
  • Port numbers match manifests (ambient-api-server-service.yml: 8000/4433/4434)

🤖 Generated with Claude Code

@markturansky markturansky force-pushed the docs/ambient-api branch 2 times, most recently from f38af57 to 5f4eb42 Compare March 5, 2026 03:24
…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 <noreply@anthropic.com>
@ambient-code
Copy link

ambient-code bot commented Mar 5, 2026

Merge Readiness — Blockers Found

Check Status Detail
CI pass
Merge conflicts FAIL Has merge conflicts
Review comments pass
Jira hygiene pass
Staleness pass
Diff overlap risk pass

This comment is auto-generated by the PR Overview workflow and will be updated when the PR changes.

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