docs: add missing context to overview/architecture/ops/troubleshooting

This commit is contained in:
Abhimanyu Saharan
2026-02-11 09:45:29 +00:00
parent 04c6822ea8
commit 7be38140a1
4 changed files with 106 additions and 46 deletions

View File

@@ -4,19 +4,19 @@
- [Troubleshooting deep dive](troubleshooting/README.md)
This is the high-level troubleshooting entry point (minimal churn).
This is the “quick triage” page. For detailed playbooks and diagnostics, use the deep dive.
## Quick triage
### Symptom: frontend loads but shows API errors
- Confirm `NEXT_PUBLIC_API_URL` points to a reachable backend.
### Frontend loads but shows API errors
- Confirm `NEXT_PUBLIC_API_URL` points to a backend your browser can reach.
- Check backend `/healthz`.
### Symptom: frontend keeps redirecting / Clerk errors
- If you are running locally without Clerk, ensure `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` is **unset/blank**.
### Frontend keeps redirecting / Clerk errors
- If youre running locally without Clerk, keep `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` unset/blank.
- See: [repo README Clerk note](../README.md#note-on-auth-clerk).
### Symptom: backend 5xx
### Backend returns 5xx
- Check DB connectivity (`DATABASE_URL`) and migrations.
- Check backend logs.