docs(comms): TL;DR prologue for consumer guide (comms-etiquette v1.0)

This commit is contained in:
2026-10-19 19:40:08 +00:00
parent bbed068a0c
commit d57bec9bf5
+20
View File
@@ -1,5 +1,25 @@
# Consumer Guide — Declare intent, deploy to AWS
**TL;DR** — This guide takes a consumer from an empty repository to
applied AWS infrastructure: create a repo, write one YAML contract,
validate offline, then run the platform script against AWS.
**What** —
- Step-by-step contract authoring with a worked static-site example,
generic across all modules.
- A field-by-field reference for contract and module inputs.
- Offline validation first (no AWS); the live AWS run second.
**Why** — The contract is the whole consumer interface; infrastructure
code stays platform-side.
**Action** — No action — FYI. Follow Steps 1-6 below when ready to
deploy.
**Details** — The platform README (commands and credentials);
[`docs/contracts/`](contracts/index.md) (contract shapes).
This guide walks a consumer through creating a repo, writing a contract,
validating it offline, and running it against AWS. It is **generic** across
all modules in the registry; `static-assets` is the worked example, but