docs

docs/user/getting-started.md

@@ -0,0 +1,41 @@
+# User Getting Started
+
+## Required Setup
+
+1. Copy `.env.example` to `.env`.
+2. Set `POSTGRES_PASSWORD`.
+3. Set `SESSION_SECRET_KEY`.
+
+## Deploy Method A: Prebuilt Image
+
+```bash
+docker compose pull
+docker compose up -d
+```
+
+Open:
+- App/API: `http://localhost:8000`
+- Health endpoint: `http://localhost:8000/healthz`
+
+Upgrade:
+
+```bash
+docker compose pull
+docker compose up -d
+```
+
+## Deploy Method B: Local Source + Dev Frontend
+
+```bash
+docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
+```
+
+Open:
+- API: `http://localhost:8000`
+- Frontend dev server: `http://localhost:5173`
+
+Stop:
+
+```bash
+docker compose -f docker-compose.yml -f docker-compose.dev.yml down
+```

docs/user/overview.md

@@ -0,0 +1,5 @@
+# User Documentation
+
+Use this section if you are deploying and using scholarr.
+
+- [Getting Started](./getting-started.md)