Document CDK app and cdk.json in README #12

Merged
amoussa1229 merged 1 commit from docs/readme-document-cdk-app into main 2026-07-10 20:07:29 +00:00
amoussa1229 commented 2026-07-10 19:56:31 +00:00 (Migrated from github.com)

Summary

The README documented the deployed controls, config inputs, and CI/CD, but never explained that this repo is a CDK app or what cdk.json is for. This adds a CDK app section so contributors can orient without reading the source.

Validation

  • Verified against the actual source: cdk.json (app/watch/context), bin/app.ts (stackName, account 396287094661, us-east-1, flowLogVpcIds context), lib/external-dev-baseline-stack.ts and its three constructs (detective-controls, flow-logs, governance-toggles), package.json scripts, and .gitignore.
  • No invented details; the new layout table and command list mirror what is in the repo.

Tests

None — documentation-only change. No code, IaC, or CI affected.

Notes

README-only; no deploy or behavior change.

## Summary The README documented the deployed controls, config inputs, and CI/CD, but never explained that this repo is a CDK app or what `cdk.json` is for. This adds a **CDK app** section so contributors can orient without reading the source. ## Validation - Verified against the actual source: `cdk.json` (`app`/`watch`/context), `bin/app.ts` (stackName, account `396287094661`, us-east-1, `flowLogVpcIds` context), `lib/external-dev-baseline-stack.ts` and its three constructs (`detective-controls`, `flow-logs`, `governance-toggles`), `package.json` scripts, and `.gitignore`. - No invented details; the new layout table and command list mirror what is in the repo. ## Tests None — documentation-only change. No code, IaC, or CI affected. ## Notes README-only; no deploy or behavior change.
seahaven-openswe[bot] (Migrated from github.com) reviewed 2026-07-10 19:58:37 +00:00
seahaven-openswe[bot] (Migrated from github.com) left a comment

✅ Open SWE Review: No issues found

Open SWE reviewed this PR and found no potential bugs to report.

Open in Web

## ✅ Open SWE Review: No issues found Open SWE reviewed this PR and found no potential bugs to report. [Open in Web](https://openswe.seahaven.com/agents/reviews/Sea-Haven-Industries/seahaven-external-dev-baseline/12) <!-- open-swe-reviewer pr=12 -->
This repo is archived. You cannot comment on pull requests.
No description provided.