Rewrite README: concise docs, badges, and workflow - #8
BarryHenryJr wants to merge 1 commit into
Conversation
Replace the verbose README with a streamlined, modern overview: add CI and tech badges, concise why/architecture/usage sections, and Mermaid diagrams. Consolidate Quick Start and local dev workflow to pnpm-based commands (pnpm services / pnpm dev), update API surface into tables, and move developer notes into referenced backend/SETUP.md. Remove prior long examples and implementation prose in favor of compact commands, repo layout, useful command table, and clarified non-goals.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly refactors the project's Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides an excellent rewrite of the README.md, making it significantly more concise, modern, and easier for developers to navigate. The use of badges, Mermaid diagrams, and summary tables is a great improvement. I have a couple of minor suggestions to make the documentation even more complete.
| | Command | Purpose | | ||
| | --- | --- | | ||
| | `pnpm generate:api-types` | Export OpenAPI and regenerate frontend types | | ||
| | `pnpm validate:all` | Run backend, frontend, and SDK validation | | ||
| | `pnpm test` | Run backend, frontend, and SDK tests | | ||
| | `pnpm seed` | Seed realistic sample events | | ||
| | `pnpm stop` | Stop local app processes | |
There was a problem hiding this comment.
The "Useful commands" table is a great addition. To make it even more comprehensive for developers, consider re-introducing some useful commands from the previous README version that are still present in package.json, such as validate:backend, validate:frontend, and seed:clean.
| | Command | Purpose | | |
| | --- | --- | | |
| | `pnpm generate:api-types` | Export OpenAPI and regenerate frontend types | | |
| | `pnpm validate:all` | Run backend, frontend, and SDK validation | | |
| | `pnpm test` | Run backend, frontend, and SDK tests | | |
| | `pnpm seed` | Seed realistic sample events | | |
| | `pnpm stop` | Stop local app processes | | |
| | Command | Purpose | | |
| | --- | --- | | |
| | `pnpm generate:api-types` | Export OpenAPI and regenerate frontend types | | |
| | `pnpm validate:backend` | Run backend validation checks | | |
| | `pnpm validate:frontend` | Run frontend validation checks | | |
| | `pnpm validate:all` | Run all validation checks | | |
| | `pnpm test` | Run all tests | | |
| | `pnpm seed` | Seed realistic sample events | | |
| | `pnpm seed:clean` | Wipe and reseed events | | |
| | `pnpm stop` | Stop local app processes | |
| - Treat `backend/poetry.lock` and `pnpm-lock.yaml` as the dependency source of truth. | ||
| - Do not reintroduce `npm` lockfiles or a standalone backend `requirements.txt`. | ||
| - Keep frontend API types generated from the backend schema, not hand-maintained. | ||
| Deeper backend setup lives in [`backend/SETUP.md`](backend/SETUP.md). |
There was a problem hiding this comment.
For clarity and to ensure compatibility with a wider range of Markdown parsers, it's good practice to use explicit relative links for files within the repository.
| Deeper backend setup lives in [`backend/SETUP.md`](backend/SETUP.md). | |
| Deeper backend setup lives in [`backend/SETUP.md`](./backend/SETUP.md). |
There was a problem hiding this comment.
Pull request overview
This PR replaces the verbose project README with a streamlined, modern version featuring badges, Mermaid architecture diagrams, concise tables for the API surface and repo layout, and a simplified Quick Start flow using pnpm commands.
Changes:
- Replaced prose-heavy sections (architecture, API details, backend/frontend notes) with badge links, Mermaid diagrams, and compact tables.
- Consolidated the Quick Start into a short
pnpm-based workflow (pnpm install→pnpm services→pnpm dev). - Moved detailed backend setup notes to the referenced
backend/SETUP.mdand trimmed non-goals.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| pnpm services | ||
| pnpm dev |
Replace the verbose README with a streamlined, modern overview: add CI and tech badges, concise why/architecture/usage sections, and Mermaid diagrams. Consolidate Quick Start and local dev workflow to pnpm-based commands (pnpm services / pnpm dev), update API surface into tables, and move developer notes into referenced backend/SETUP.md. Remove prior long examples and implementation prose in favor of compact commands, repo layout, useful command table, and clarified non-goals.