Progressive disclosure for task-specific documentation and references.
- Governance
- Architecture Decisions
- Development Context
- Code Patterns
- Component Guides
- Development Environment
- Testing
- Observability
- Design Documents
- Dependency Automation
- Amber Automation
| Document | Purpose |
|---|---|
| ACP Constitution | 10 core principles: K8s-native, security, type safety, TDD, modularity, observability, lifecycle, context engineering, data access, commit discipline |
| Runner Constitution | Version pinning, automated freshness, image discipline, schema sync, bridge modularity |
| SDD Preflight | CI workflow enforcing constitution compliance on PRs |
| ADR | Decision |
|---|---|
| ADR-0001 | CRDs, operators, and Job-based execution over traditional API |
| ADR-0002 | User tokens for API ops instead of service accounts |
| ADR-0003 | Multi-repository support in a single session |
| ADR-0004 | Go for backend/operator, Python for runner |
| ADR-0005 | NextJS + Shadcn + React Query frontend stack |
| ADR-0006 | Runner SDK design and architecture |
| ADR-0007 | Unleash with workspace-scoped overrides |
| Context | Scope |
|---|---|
| Backend | Go patterns, K8s integration, handler conventions, user-scoped clients |
| Frontend | NextJS patterns, Shadcn, React Query, component guidelines |
| Security | Auth flows, RBAC, token handling, container security |
| Pattern | Scope |
|---|---|
| Error Handling | Consistent error patterns across backend, operator, runner |
| K8s Client Usage | User token vs. service account — critical for RBAC compliance |
| React Query | Data fetching hooks, mutations, cache invalidation |
| Guide | Purpose |
|---|---|
| Backend README | Go API development, testing, handler structure |
| Backend Test Guide | Testing strategies, test utilities, integration test setup |
| Frontend README | NextJS development, local setup, environment config |
| Frontend Design Guidelines | Component patterns, Shadcn usage, type conventions |
| Frontend Component Patterns | Architecture patterns for React components |
| Operator README | Operator development, watch patterns, reconciliation loop |
| Runner README | Python runner, Claude Code SDK integration |
| Public API README | Stateless gateway, token forwarding, input validation |
| API Server Guide | rh-trex-ai REST API, plugin system, code generation |
| SDK Guide | Go + Python client libraries for the public API |
| CLI README | acpctl CLI for managing agentic sessions |
| Guide | Purpose |
|---|---|
| Kind | Recommended local dev setup (Kubernetes in Docker) |
| OpenShift | OpenShift Local (CRC) setup for OCP-specific features |
| Hybrid | Run components locally with breakpoint debugging |
| Manifests | Kustomize overlay structure, deploy.sh usage |
| Guide | Purpose |
|---|---|
| E2E Testing Guide | Writing and running Cypress E2E tests |
| E2E README | Running E2E tests, environment setup, CI integration |
| Guide | Purpose |
|---|---|
| Overview | Monitoring, metrics, and tracing architecture |
| Langfuse | LLM tracing with privacy-preserving defaults |
| Operator Metrics | Grafana dashboards for operator metrics |
| Document | Purpose |
|---|---|
| Declarative Session Reconciliation | Session lifecycle via declarative status transitions |
| Runner-Operator Contract | Interface contract between operator and runner pods |
| Session Status Redesign | Status field evolution and phase transitions |
| Session Initialization Flow | How sessions are initialized and configured |
| Spec-Runtime Synchronization | Keeping spec and runtime state in sync |
| Agent Runtime Registry | Agent runtime registry architecture |
| CLI Runners | CLI runner design and implementation |
| Status Update Comparison | Comparison of status update approaches |
| Resource | Purpose |
|---|---|
| SDK Version Bump Workflow | Daily check for claude-agent-sdk + anthropic updates, auto-PR |
| SDK Version Bump Script | PyPI version check, pyproject.toml update, changelog fetch |
| SDK Feature Report Generator | Parse release notes into structured feature data |
| Resource | Purpose |
|---|---|
| Amber Config | Automation policies and label mappings |