Document CDK app structure in README #11

Merged

amoussa1229 merged 1 commit from docs/readme-document-cdk-app into main

2026-07-10 20:07:17 +00:00

amoussa1229 commented

2026-07-10 19:56:44 +00:00

(Migrated from github.com)

Summary

The README documented the deployed architecture and AWS resources but never explained that this repo is itself an AWS CDK v2 app — cdk.json and the bin//lib/ layout were undocumented, so the infrastructure-as-code component was invisible to anyone opening the codebase. This adds a "CDK app" section mapping each file to its role.

Validation

Docs-only change. Verified every referenced fact against the tree: cdk.json app = npx tsx bin/app.ts; bin/app.ts instantiates a single RustdeskServerStack with stackName: "rustdesk-server" on account 328440206208 / us-east-1; lib/rustdesk-server-stack.ts holds all resources and the tunable constants; aws-cdk-lib pinned exact in package.json; cdk.out/ git-ignored.

Tests

None — README-only change, no code paths affected.

Notes

New section slotted between Architecture and Documentation and cross-links the existing Resources and Deployment sections; no existing content changed.

## Summary The README documented the deployed architecture and AWS resources but never explained that this repo is itself an AWS CDK v2 app — `cdk.json` and the `bin/`/`lib/` layout were undocumented, so the infrastructure-as-code component was invisible to anyone opening the codebase. This adds a "CDK app" section mapping each file to its role. ## Validation Docs-only change. Verified every referenced fact against the tree: `cdk.json` `app` = `npx tsx bin/app.ts`; `bin/app.ts` instantiates a single `RustdeskServerStack` with `stackName: "rustdesk-server"` on account `328440206208` / `us-east-1`; `lib/rustdesk-server-stack.ts` holds all resources and the tunable constants; `aws-cdk-lib` pinned exact in `package.json`; `cdk.out/` git-ignored. ## Tests None — README-only change, no code paths affected. ## Notes New section slotted between Architecture and Documentation and cross-links the existing Resources and Deployment sections; no existing content changed.

seahaven-openswe[bot] (Migrated from github.com) reviewed 2026-07-10 19:57:39 +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/rustdesk-server/11)

This repo is archived. You cannot comment on pull requests.

No reviewers