docs(readme): enhance project description and visual elements#145
docs(readme): enhance project description and visual elements#145
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository README to present DevBits with a more polished product narrative and richer visual/branding elements for the main entry point of the codebase.
Changes:
- Replaces the plain Markdown header/outline with centered HTML branding, badges, and preview images.
- Adds product identity sections, visual gallery tables, and feature summaries using
<details>blocks. - Reorganizes “Explore More” links at the bottom of the README.
| - [backend/docs/AWS_TRANSFER_NO_NGINX.md](backend/docs/AWS_TRANSFER_NO_NGINX.md) | ||
| - Product and deployment runbook: [INSTRUCTIONS.md](INSTRUCTIONS.md) | ||
| - Backend structure and scripts: [backend/scripts/README.md](backend/scripts/README.md) | ||
| - AWS deployment notes: [docs/AWS_TRANSFER_NO_NGINX.md](docs/AWS_TRANSFER_NO_NGINX.md) |
There was a problem hiding this comment.
The link to the AWS deployment notes points to docs/AWS_TRANSFER_NO_NGINX.md, but there is no top-level docs/ directory in the repo; the file currently lives at backend/docs/AWS_TRANSFER_NO_NGINX.md. Update the README link target to avoid a broken reference.
| - AWS deployment notes: [docs/AWS_TRANSFER_NO_NGINX.md](docs/AWS_TRANSFER_NO_NGINX.md) | |
| - AWS deployment notes: [backend/docs/AWS_TRANSFER_NO_NGINX.md](backend/docs/AWS_TRANSFER_NO_NGINX.md) |
| ## Project Story | ||
|
|
||
| ## Static file sync | ||
| DevBits exists to make technical progress visible. | ||
|
|
||
| `backend/api/static/` is the source of truth for compliance and deep-linking files | ||
| (`apple-app-site-association`, `privacy-policy.html`, `account-deletion.html`). | ||
| The same files are mirrored into `frontend/public/` for the Expo web build. | ||
| Instead of posting polished outcomes only, builders can share: | ||
|
|
||
| Run `Bash-Scripts/sync-static.sh` after editing any file in `backend/api/static/` | ||
| to keep the frontend copy in sync. | ||
| - What they are building now | ||
| - What broke today | ||
| - What they learned while fixing it | ||
| - What they are shipping next | ||
|
|
||
| ## Deployment DB scripts | ||
| > [!TIP] | ||
| > The goal is simple: give developers a social home for real work in progress. | ||
|
|
||
| All deployment database script commands and usage are documented in: | ||
| ## Explore More | ||
|
|
||
| - [backend/scripts/README.md](backend/scripts/README.md) | ||
| - [backend/docs/AWS_TRANSFER_NO_NGINX.md](backend/docs/AWS_TRANSFER_NO_NGINX.md) | ||
| - Product and deployment runbook: [INSTRUCTIONS.md](INSTRUCTIONS.md) | ||
| - Backend structure and scripts: [backend/scripts/README.md](backend/scripts/README.md) | ||
| - AWS deployment notes: [docs/AWS_TRANSFER_NO_NGINX.md](docs/AWS_TRANSFER_NO_NGINX.md) |
There was a problem hiding this comment.
This rewrite removes the prior “Local Development” / quick-start and troubleshooting content from the README without providing an equivalent developer onboarding section elsewhere (INSTRUCTIONS.md is deployment-focused). If the intent is only to enhance visuals/description, consider restoring a minimal local dev quick start (or moving it to a dedicated doc and linking it here) to avoid losing setup guidance.
No description provided.