docs: replace stale READMEs with accurate RxNote documentation and add logo#6
docs: replace stale READMEs with accurate RxNote documentation and add logo#6
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: sirily11 <32106111+sirily11@users.noreply.github.com>
|
@copilot generate a logo for my rxnote for readme |
Co-authored-by: sirily11 <32106111+sirily11@users.noreply.github.com>
Added an SVG logo in The logo features a blue-to-indigo rounded square, a note card with folded corner, "Rx" in serif text, note lines, and small QR dot accents. |
There was a problem hiding this comment.
Pull request overview
Updates the repository documentation to accurately describe the RxNote project (iOS app + Next.js backend), replacing placeholder/boilerplate READMEs.
Changes:
- Replaced the root
README.mdplaceholder with an RxNote project overview, quick-start steps, repo structure, and build/test commands. - Replaced
backend/README.mdboilerplate with RxNote backend-specific documentation (features, stack, structure, env vars, scripts, API spec pointer).
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Adds repo-level documentation for running/building/testing both backend and iOS targets. |
| backend/README.md | Adds backend-specific quick start, feature/stack overview, structure, scripts, and OpenAPI reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| cp .env.example .env | ||
| # Edit .env with your credentials (see Environment Variables below) |
There was a problem hiding this comment.
cp .env.example .env references a file that isn't present in backend/ (no .env.example in the repo). Update the quick-start to point at the actual env template (if any) or explain which .env* file to create / which variables must be exported before running db:push and dev.
| cp .env.example .env | |
| # Edit .env with your credentials (see Environment Variables below) | |
| # Create a .env file in backend/ with the variables listed in "Environment Variables" below | |
| # (at minimum: AUTH_SECRET, AUTH_ISSUER, AUTH_CLIENT_ID, AUTH_CLIENT_SECRET, TURSO_DATABASE_URL, TURSO_AUTH_TOKEN, NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN, NEXT_PUBLIC_URL) |
| | `TURSO_DATABASE_URL` | Turso database URL | | ||
| | `TURSO_AUTH_TOKEN` | Turso auth token | | ||
| | `NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN` | Mapbox access token | | ||
| | `NEXT_PUBLIC_URL` | Public URL for preview links and QR codes | |
There was a problem hiding this comment.
The Environment Variables table is incomplete relative to what the backend actually reads. For example, S3 uploads require S3_ENDPOINT, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_BUCKET (and optionally S3_PUBLIC_URL), App Clip/AASA routes require APPLE_TEAM_ID, APPLE_APP_BUNDLE_ID, APPLE_APP_CLIP_BUNDLE_ID, and account deletion uses QSTASH_TOKEN / signing keys. Please add these (or explicitly mark them optional/feature-specific) so the README matches runtime requirements.
| | `NEXT_PUBLIC_URL` | Public URL for preview links and QR codes | | |
| | `NEXT_PUBLIC_URL` | Public URL for preview links and QR codes | | |
| | `S3_ENDPOINT` | S3-compatible endpoint URL used for presigned uploads (required for File Uploads feature) | | |
| | `S3_ACCESS_KEY_ID` | S3 access key ID (required for File Uploads feature) | | |
| | `S3_SECRET_ACCESS_KEY` | S3 secret access key (required for File Uploads feature) | | |
| | `S3_BUCKET` | S3 bucket name for storing uploaded files (required for File Uploads feature) | | |
| | `S3_PUBLIC_URL` | Optional base public URL for serving uploaded files (optional, used if different from `S3_ENDPOINT`) | | |
| | `APPLE_TEAM_ID` | Apple Developer Team ID (required for App Clips / Apple App Site Association routes) | | |
| | `APPLE_APP_BUNDLE_ID` | iOS app bundle identifier (required for App Clips / Apple App Site Association routes) | | |
| | `APPLE_APP_CLIP_BUNDLE_ID` | App Clip bundle identifier (required for App Clips support) | | |
| | `QSTASH_TOKEN` | QStash token used for account deletion/webhook requests (required for Account Deletion API) | | |
| | `QSTASH_SIGNING_KEY_CURRENT` | Current QStash signing key for verifying account deletion requests (required for Account Deletion API) | | |
| | `QSTASH_SIGNING_KEY_NEXT` | Next QStash signing key for key rotation (optional, used for Account Deletion API) | |
| ## Quick Start | ||
|
|
||
| ### Backend | ||
|
|
There was a problem hiding this comment.
cp .env.example .env references a file that isn't present at the repo root under backend/ (no backend/.env.example in the repo). Either add that template file or update the quick-start to the correct env file name/location (or document which variables must be set).
| # create and configure .env (see backend/README.md for required variables) |
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |

Root
README.mdwas a single-line# storage-managementplaceholder;backend/README.mdwas unmodifiedcreate-next-appboilerplate. Neither described the actual RxNote project.Changes
README.md— Full project overview: what RxNote is, quick-start for both backend and iOS, repo structure tree, build/test commands, feature highlights, and links to sub-READMEs. Includes the new RxNote logo at the top.backend/README.md— RxNote-specific backend docs: feature list, tech stack, directory structure, environment variables table, available scripts, and a pointer to the OpenAPI spec.docs/logo.svg— New SVG logo featuring a blue-to-indigo rounded square, a note card with folded corner, "Rx" in serif text, note line decorations, and small QR dot accents.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.