Skip to content

docs: rewrite README with comprehensive documentation#3

Open
kiro-agent[bot] wants to merge 1 commit intomainfrom
improve-readme
Open

docs: rewrite README with comprehensive documentation#3
kiro-agent[bot] wants to merge 1 commit intomainfrom
improve-readme

Conversation

@kiro-agent
Copy link

@kiro-agent kiro-agent bot commented Mar 16, 2026

This pull request was generated by @kiro-agent 👻

Comment with /kiro fix to address specific feedback or /kiro all to address everything.
Learn about Kiro autonomous agent


Summary

Rewrites the README.md from a minimal set of instructions into a comprehensive project document.

What changed

  • Architecture section with ASCII diagram and step-by-step request flow explanation
  • AWS Services table listing all six services used and their purpose
  • Annotated project structure explaining every significant file
  • Prerequisites table with specific version requirements (Java 17, Maven 3.8+, CDK 2.x, AWS CLI, jq, curl)
  • Detailed build, deploy, and test instructions including first-time CDK bootstrap and manual curl examples
  • API reference with request/response JSON examples
  • Data model documenting Unicorn fields and EventBridge event types
  • Load testing instructions using the included Artillery config
  • Cleanup instructions to tear down all AWS resources
  • Key implementation details covering SnapStart, async init, CRT HTTP client, Tomcat exclusion, and Spring Boot 3 Jakarta EE migration
  • References linking to all relevant AWS docs, libraries, and the workshop
  • Preserved existing screenshot references (img/result.png, img/logs.png)

What was tested

  • Verified all source file references (class names, package paths, dependency versions) match the actual codebase
  • Confirmed all external links are valid

- Add architecture overview with request flow diagram
- Document all AWS services used (Lambda, API Gateway, EventBridge, SnapStart)
- Add detailed project structure explanation
- Include prerequisites table with versions
- Add build, deploy, and test instructions
- Document API endpoints and data model
- Add load testing, cleanup, and key implementation details sections
- Include references to related AWS documentation and workshops
- Preserve existing image references (result.png, logs.png)

Co-authored-by: Maximilian Schellhorn <36627945+maschnetwork@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant