Revise README content for improved clarity#1
Merged
Conversation
Refactor README for clarity and structure, updating features and AI workflow sections.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR refactors README.md to improve clarity and structure by simplifying the introduction and consolidating key sections (features, architecture/AI workflow, tech stack, project structure, setup/testing, deployment, and license).
Changes:
- Rewrites the README intro and reorganizes content around Features → Architecture → AI Workflow → Tech Stack.
- Simplifies the project structure and getting-started instructions.
- Replaces detailed setup/testing/deployment/license prose with shorter, higher-level guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| Or run services individually: | ||
| Create `.env` files for `server` and `ai_service` using the provided `.env.example` files. |
Comment on lines
71
to
75
| cd ai_service | ||
| pytest tests/ -v | ||
| ``` | ||
| pytest | ||
|
|
||
| **Node.js (54 tests):** | ||
| ```bash | ||
| cd server | ||
| cd ../server | ||
| npm test |
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
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.
Refactor README for clarity and structure, updating features and AI workflow sections.