Skip to content

Commit bbd341c

Browse files
committed
docs: update batteries, deployment, and project documentation
- BATTERIES.md: rewrite to match actual source, add Pagination/Caching/Social OAuth - README.md, CONTRIBUTING.md, CLAUDE.md, DEPLOYMENT.md: various improvements
1 parent ca3bca7 commit bbd341c

5 files changed

Lines changed: 424 additions & 121 deletions

File tree

CLAUDE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Handlers switch on `result.type` and map to HTTP responses.
4141

4242
## Module Structure
4343

44-
```
44+
```bash
4545
modules/{name}/
4646
routes.ts # OpenAPI route definitions
4747
handlers.ts # HTTP handlers
@@ -86,10 +86,12 @@ import { addJob } from "@/jobs";
8686
## Environment
8787

8888
Required in `.env`:
89+
8990
- `DATABASE_URL`
9091
- `BETTER_AUTH_SECRET` (32+ chars)
9192

9293
Optional:
94+
9395
- `REDIS_URL` — for jobs/caching
9496
- `S3_*` — for file uploads
9597
- `RESEND_API_KEY` — for email

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ try {
6666

6767
Be specific. Say what changed and why.
6868

69-
```
69+
```git
7070
# Good
7171
fix(auth): handle expired refresh tokens
7272

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ See [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) for the full guide.
165165

166166
## Project Layout
167167

168-
```
168+
```bash
169169
apps/backend/src/
170170
modules/ ← Your features go here
171171
lib/ ← Reusable utilities

0 commit comments

Comments
 (0)