Merge pull request 'docs: TL;DR prologues — README + consumer-guide (comms-etiquette v1.0)' (#2) from docs/comms-tldr into main

Reviewed-on: #2
This commit was merged in pull request #2.
This commit is contained in:
2026-10-19 22:57:31 +00:00
3 changed files with 49 additions and 0 deletions
+23
View File
@@ -5,6 +5,29 @@
> it through the Terraform adapter, and applies it. Every deployment is
> reproducible from the shell, not just in CI.
**TL;DR** — Nova Platform turns a small YAML contract into AWS
infrastructure: declare modules and inputs, and the platform resolves the
contract, compiles Terraform, and applies it. The last tagged release
(v0.1.6) predates CoreCI adoption; nothing has shipped under CoreCI yet.
**What** —
- One contract file per deployment: module names and versions,
environment, and module-specific inputs.
- The platform resolves the contract to a stack, compiles it through the
Terraform adapter, and applies it.
- Offline checks ship in the repo: `bash scripts/run_ci.sh` runs lint,
tests, and a check-only pass — no AWS required.
**Why** — Contract-driven deploys are reproducible and auditable; a
consumer never writes infrastructure code.
**Action** — No action — FYI. Consumers start at
[`docs/consumer-guide.md`](docs/consumer-guide.md); the product owner is
coreci-nova-po.
**Details** — Design: [`docs/architecture.md`](docs/architecture.md);
runbook: "How to run" below.
Nova Platform is the **infrastructure-delivery core** of the Nova model.
The DevSecOps, identity, audit-ledger, and central CI-pipeline-contract
machinery of the reference are intentionally removed. What remains: a
+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
+6
View File
@@ -1,5 +1,11 @@
# Nova Modules
**TL;DR** — Nova's module library: two tiers of engine-agnostic modules,
whose contract is declared in `interface.json` and translated by an adapter
(Terraform today) to concrete infrastructure. This file explains how
modules compose and how to add one; the L1/L2 tables and adapter detail
follow below.
Nova ships a two-tier module library. Modules are **engine-agnostic**:
their contract is declared in `interface.json` (stack types like
`aws:s3:bucket`), and an adapter translates the contract to a concrete