Repository navigation
docs: refresh README and move detail into docs/ - #17
Merged
Merged
Conversation
The README had grown to 370 lines mixing setup, runbook, security model, test internals and rule reference. Keep it to what a reader needs first (what it is, features incl. guest access, architecture, dev/tests, env, deployment summary, limitations) and move the detail into: - docs/deployment.md: migrations 001-003 (runner or Data API from CloudShell), Lambda zip-swap deploy and env, S3 CORS/trigger/lifecycle, SQS, EventBridge api-destination schedules, least-privilege IAM - docs/operations.md: runbook - docs/security-model.md: security model and guest limits - docs/transform-rules.md: rule reference Test-suite coverage and test-only switches move to CONTRIBUTING.md. Code comments that pointed at old README sections now point at docs/.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Lambda names confirmed in AWS (us-east-1): cleanstack-profiler, cleanstack-executor, cleanstack-ai-trigger, cleanstack-drift. Replace the <function name> placeholder with a name table and a zip-swap loop. EventBridge: rules cleanstack-reconciler-5min and cleanstack-purge-guests-hourly, their API destinations, the shared connection cleanstack-reconciler-auth and the per-destination inline policies on cleanstack-eventbridge-invoker.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Refresh the README (370 → 122 lines) and move the detail into
docs/:docs/deployment.md: migrations 001–003 (viarun-migration.mjs, or the RDS Data API from CloudShell), the Lambda zip-swap deploy, Lambda env vars, S3 (raw CORS with PUT/GET/POST, the trigger on all object create events, processed CORS, theguest_lifecycle rule), the SQS queues, the EventBridge API-destination schedules (reconcile every 5 min, purge-guests hourly,cleanstack-eventbridge-invoker), and least-privilege IAM forcleanstack-verceland the Lambda rolesdocs/operations.md: the runbookdocs/security-model.md: the security model and the guest limits tabledocs/transform-rules.md: the rule referenceTest-suite coverage, the 6 required checks and the test-only switches move to CONTRIBUTING.md. Code comments and SECURITY.md that pointed at old README sections now point at
docs/. The comment edits change no code.Why
Dhyey asked for a brief, professional README that matches the code and today's production setup.
Look hardest at
docs/deployment.md. I derived them from the S3, SQS, RDS Data API and Bedrock calls insrc/andlambdas/. That includesbedrock:InvokeModelWithResponseStream, because the chat builder usesstreamText, ands3:DeleteObjectfor the executor's fallback path.splitStatementsinrun-migration.mjs; I checked that both produce the same 14 statements.Verified
src/lib/env.tsand every Lambdaos.environread is documented./api/guestreportsenabled: true.