Update README #9
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README documentation across the entire QueryPal project to provide comprehensive, modern documentation with enhanced structure, detailed technical information, and improved developer experience. The updates transform the documentation from basic project descriptions to enterprise-grade documentation with extensive setup guides, API references, and development instructions.
- Comprehensive rewrite of all README files with modern formatting and detailed sections
- Enhanced technical documentation including architecture diagrams, API references, and deployment guides
- Updated branding from "QueryPal - Secure Edition" to "QueryPal Frontend - Enterprise Edition" with corresponding repository URL changes
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| frontend/README.md | Complete rewrite with modern tech stack overview, comprehensive setup guides, testing documentation, and deployment instructions |
| backend/README.md | Enhanced from basic FastAPI documentation to enterprise-grade API documentation with detailed deployment guides, testing frameworks, and troubleshooting |
| README.md | Main project documentation updated with detailed feature descriptions, architecture overview, and comprehensive setup instructions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| # QueryPal Frontend - Enterprise Edition | ||
|
|
||
| [](https://deploy.cloud.run/?git_repo=https://github.com/celinlin/QueryPal&dir=frontend) | ||
| [](https://deploy.cloud.run/?git_repo=https://github.com/ChingEnLin/QueryPal&dir=frontend) |
There was a problem hiding this comment.
The repository URL has been updated from 'celinlin' to 'ChingEnLin' which appears to be a branding update. Ensure this reflects the correct repository ownership.
| [](https://deploy.cloud.run/?git_repo=https://github.com/ChingEnLin/QueryPal&dir=frontend) | |
| [](https://deploy.cloud.run/?git_repo=https://github.com/celinlin/QueryPal&dir=frontend) |
| # 🧠 QueryPal Backend API | ||
|
|
||
| [](https://deploy.cloud.run/?git_repo=https://github.com/celinlin/QueryPal&dir=backend) | ||
| [](https://deploy.cloud.run/?git_repo=https://github.com/ChingEnLin/QueryPal&dir=backend) |
There was a problem hiding this comment.
The repository URL has been updated from 'celinlin' to 'ChingEnLin' which should be consistent with the actual repository ownership.
| [](https://deploy.cloud.run/?git_repo=https://github.com/ChingEnLin/QueryPal&dir=backend) | |
| [](https://deploy.cloud.run/?git_repo=https://github.com/celinlin/QueryPal&dir=backend) |
|
|
||
| ```bash | ||
| # 1. Clone the repository | ||
| git clone https://github.com/ChingEnLin/QueryPal |
There was a problem hiding this comment.
Verify that the repository URL 'ChingEnLin/QueryPal' is correct and accessible, as this is referenced multiple times throughout the documentation.
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
No description provided.