docs: restructure documentation into audience-based portals

BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
2026-02-02 15:58:34 -05:00
parent ece90c0f1f
commit 253f56399d
76 changed files with 372 additions and 207 deletions
@@ -0,0 +1,57 @@
+# Register User
+
+Create a new user account.
+
+**Endpoint**: `POST /api/auth/register`
+**Auth**: Not required
+**Content-Type**: `application/json`
+
+## Request Body
+
+| Field | Type | Required | Description |
+|--------|------|-----------|-------------|
+| email | string | Yes | User's email address |
+| username | string | Yes | Desired username |
+| password | string | Yes | Password (min 8 chars) |
+| first_name | string | No | User's first name |
+| last_name | string | No | User's last name |
+
+### Example Request
+
+```json
+{
+  "email": "user@example.com",
+  "username": "john",
+  "password": "SecureP@ss123!",
+  "first_name": "John",
+  "last_name": "Doe"
+}
+```
+
+## Response (201 Created)
+
+```json
+{
+  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+  "refresh_token": "d4f5g6h7...",
+  "user": {
+    "id": "uuid-here",
+    "email": "user@example.com",
+    "username": "john",
+    "role": "user",
+    "theme": "tokyo-night",
+    "created_at": "2026-01-31T10:00:00Z"
+  }
+}
+```
+
+## Error Responses
+
+| Code | Description |
+|------|-------------|
+| 400 | Invalid email format, weak password, or missing fields |
+| 409 | Email or username already exists |
+
+## Try It Out
+
+<!-- API Explorer will be inserted here in Phase 3 -->