Files

T

Jon Chery 553caf8f1d docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

---ci---
project: acdl
phase: 21
milestone: v1.6
status: execute
---/ci---

README.md rewrite:
- Remove all .ciagent/ references (links + repository-layout row).
- Remove .gitea/workflows/ row from repository layout.
- Restate repository roles: consumer repo = app code + 1+ contracts +
  CI definitions (thin .github/workflows/*.yml uses:-ing the central
  workflow); platform repo owns modules/adapters/core/schemas/pipelines/
  scripts/workflows.
- Replace Status section with Features list (consumer + platform-engineer
  referenceable) + Roadmap (planned only, no version changelog, no
  internal CIAgent status). Includes the composition-redesign roadmap
  entry (dynamic module creation from a contract).
- Fix the mermaid flowchart: all node text visible (short multi-line
  labels via <br/>), add a security-checks stage before policy checks,
  do not name specific tools (security checks/policy checks/infrastructure
  plan via adapter), add infrastructure-apply stage (dev only, after
  evidence event).
- Remove the environments table (dev/qa/prod/dr) completely; point to
  docs/environments/ for platform-managed environments.
- Credentials section: remove go-gitea/gitea#36988 blocked mention +
  waivers D-039/D-047 language. State OIDC+ABAC default; alternative is a
  static AWS key (GitHub Secrets for platform-runner runs, .env.secrets
  locally) with daily rotation (platform-managed) or out-of-band rotation
  (consumer-managed for local .env.secrets).
- forge -> platform runners / platform-managed throughout.
- Links point to docs/ Pages paths, not .ciagent/.

modules/ terminology:
- modules/README.md: L1 primitives -> primitives, L2 compositions ->
  modules, composition -> pattern (prose); add roadmap note for the
  composition redesign.
- README-TEMPLATE.md: L1 primitive -> primitive.
- All 7 L1 READMEs: L1 primitive -> primitive.
- L2 static-asset + microservice READMEs: L2 composition -> module
  pattern, composition -> pattern, L1 -> primitive; bump stale @v1 ->
  @v1.4 in usage examples; fix CONSUMER_GUIDE.md -> consumer-guide.md
  link.

Verification: grep sweeps for .ciagent/.gitea/forge/go-gitea/waiver/
D-039/D-047/acdl_platform in docs/ README.md modules/ contracts/ all
return 0 hits. Tests: 166 pass. run_ci.sh green.

2026-07-22 18:26:00 +00:00

docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

2026-07-22 18:26:00 +00:00

docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

2026-07-22 18:26:00 +00:00

.gitkeep

docs(P20): specify phase 20 — consumer happy path + reusable deploy workflow (v1.5)

2026-07-22 17:09:23 +00:00

README-TEMPLATE.md

docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

2026-07-22 18:26:00 +00:00

README.md

docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

2026-07-22 18:26:00 +00:00

registry.json

review(v1.5): READY TO SHIP — multi-persona code review

2026-07-22 17:24:28 +00:00

README.md

ACDL Modules

Reusable building blocks for cloud infrastructure. Each module is self-documented with a README.md following the template.

How the modules work

There are two kinds of module:

Primitives — a single cloud resource or a small group of related resources (e.g. a VPC with subnets and routing). Each primitive has an interface.json declaring its inputs and outputs, and a README.md in plain language.
Modules — a pattern that references multiple primitives to deploy a complete stack (e.g. an ECS Fargate microservice). Each module has a composition.json declaring its children and wires.

The substrate adapter (adapters/terraform/adapter.py) compiles a module instance to infrastructure. Each module's README documents which resources it creates.

Primitives

Module	What it creates	README
`s3`	`aws_s3_bucket` — a single S3 bucket	README
`vpc`	`aws_vpc` + `aws_subnet` + `aws_route_table` + `aws_internet_gateway` — VPC with subnets and routing	README
`ecs-cluster`	`aws_ecs_cluster` — ECS Fargate cluster	README
`ecs-service`	`aws_ecs_task_definition` + `aws_ecs_service` — Fargate service with task definition	README
`iam-role`	`aws_iam_role` — IAM role with assume-role policy	README
`alb`	`aws_lb` + `aws_lb_target_group` + `aws_lb_listener` — Application Load Balancer	README
`ecr`	`aws_ecr_repository` — ECR container image repository	README

Modules

Module	What it references	README
`microservice`	6 primitives (vpc, cluster, ecr, iam-role, alb, ecs-service)	README
`static-asset`	1 primitive (s3)	README

Registry

Module versions are tracked in registry.json. Both primitives and modules are registered.

Template

New modules should use README-TEMPLATE.md as their starting point.

Module patterns (roadmap)

The current composition.json mechanism is a thin pattern layer. A future redesign will let a consumer dynamically create a module directly from the contract file (an agentic "composition" flow). That is on the roadmap, not implemented today.