docs: improve README formatting and readability#19
Open
prateek-shanbhag wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the project README to be more welcoming and structured, with clearer onboarding and section formatting.
Changes:
- Added emoji-enhanced section headers and reorganized “Getting Started” into prerequisites/setup/launch steps
- Reformatted the Tech Stack section and simplified “How it works” bullets
- Simplified Contributing/Docs sections into shorter bullet lists
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+19
to
+25
| | | | | ||
| | ------------- | ------------------------------------------------------------------------------------ | | ||
| | **Frontend** | **React 18**, **Vite**, **TailwindCSS**, **TanStack Query**, **React Router v6** | | ||
| | **Backend** | **Node.js 20**, **Express**, **Prisma**, **PostgreSQL** | | ||
| | **Real-time** | **Server-Sent Events (SSE)** | | ||
| | **Auth** | **Google Identity Services** _(ID token flow — no client secret needed)_ | | ||
| | **Infra** | **Docker** (local), **Render** (backend), **Vercel** (frontend), **Neon** (database) | |
Comment on lines
+9
to
+11
| 1. **Post a ride** — Add info if have spare seats. | ||
| 2. **Post an intent** — request for a ride. | ||
| 3. **Match** — Splitt finds the intended rides automatically. |
|
|
||
| Read [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) before opening a PR. | ||
| Open issues are tracked in [CLEANUP.md](CLEANUP.md) — pick one and claim it. | ||
| - Before opening any PR make sure to read **[docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)**. |
Comment on lines
+75
to
+77
| - Refer **[docs/SETUP.md](docs/SETUP.md)** — for Local setup, Google OAuth config, all dev commands | ||
| - Refer **[docs/DATA_SHAPES.md](docs/DATA_SHAPES.md)** — for Every API endpoint with request and response examples | ||
| - Refer **[docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)** — for Branch naming, commit format, PR process |
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.
What
In this PR readme documentation is updated so that it has better readability and is more welcoming for new open-source contributors.
Fixes #5
Type of change
Proof of work
Checklist
feature/,fix/,docs/)