docs: Rewrite README with comprehensive application documentation #72
Conversation
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
- Add detailed overview of the banking application features - Document technology stack including Spring Boot 3.3.3, MySQL, Thymeleaf - Include architecture diagram showing layered pattern - Add getting started guide for local development and Docker deployment - Document all API endpoints with authentication requirements - Add database schema documentation for Account and Transaction tables - Document security features including BCrypt encryption and Spring Security - Add DevOps and CI/CD section covering Jenkins pipeline - Document Kubernetes deployment manifests and Helm charts - Include monitoring setup with Prometheus and Grafana - Add contributing guidelines Co-Authored-By: Cindy Huang <cindy.huang@cognition.ai>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docs: Rewrite README with comprehensive application documentation
Summary
This PR completely rewrites the README.md to provide comprehensive application documentation instead of the previous deployment tutorial. The new README focuses on documenting the banking application itself, including its features, architecture, API endpoints, database schema, and getting started guides.
Key sections added:
The previous README contained a detailed step-by-step AWS EKS deployment tutorial with screenshots. This content has been removed in favor of application-focused documentation.
Review & Testing Checklist for Human
BankController.javaroutesREADME-K8S.mdexists and the image paths (images/login.png,images/transactions.png) are validTest plan: Render the README on GitHub to verify markdown formatting displays correctly, all links work, and tables render properly.
Notes
Link to Devin run: https://app.devin.ai/sessions/3e19e57172f14595a7fd238bfbe0d675
Requested by: Cindy Huang (cindy.huang@cognition.ai) (@cindyyhuang)