Problem
The README.md is minimal and missing several important sections for a production Lambda project:
Missing:
- Architecture diagram — No visual representation of the data pipeline (SQS → Lambda → S3 → KMS → Parquet → S3)
- Deployment instructions — No Terraform/SAM/CDK examples or manual deployment steps
- Filter configuration examples — The
filters/ directory and filter query DSL (the not, selector, and, or, contains, dimensionExists node types in filter.go) are completely undocumented
- Parquet schema documentation — The
DatabaseActivityEvent struct in main.go defines 20+ fields but there is no schema reference
- Input/Output format — No documentation of the expected S3 event format and the output Parquet structure
- Troubleshooting — No common error scenarios and resolutions
- Environment variable examples — No
.env.example file
Proposed Solution
- Add a Mermaid architecture diagram to README
- Add a "Filter Configuration" section documenting the query DSL with examples
- Add a "Deployment" section with at least manual steps
- Add a "Parquet Schema" table documenting all fields in
DatabaseActivityEvent
- Create a
.env.example file with all supported env vars
- Add a "Troubleshooting" section
Acceptance Criteria
Problem
The README.md is minimal and missing several important sections for a production Lambda project:
Missing:
filters/directory and filter query DSL (thenot,selector,and,or,contains,dimensionExistsnode types in filter.go) are completely undocumentedDatabaseActivityEventstruct in main.go defines 20+ fields but there is no schema reference.env.examplefileProposed Solution
DatabaseActivityEvent.env.examplefile with all supported env varsAcceptance Criteria
.env.examplefile exists with all env vars