Files
bookhoard/docs/user/profile-guide.md
T
john-okeefe 4d321528b2 docs: update comprehensive API documentation and project guides
This commit updates all documentation files throughout the project:

- Updated IMPLEMENTATION_PLAN.md with new implementation details
- Updated PROJECT_GUIDELINES.md with coding standards and practices
- Updated README.md with current project information
- Updated SCREENSHOT_AUTOMATION.md with new automation details
- Added TEST_DATA.md with test fixtures data
- Updated cover_image_serving_plan.md with static URL patterns

Documentation API updates:
- Updated API reference documentation for all endpoints including:
  - Authentication (login, logout, register, refresh_token)
  - Book matching (auto_link, bulk_link, link_book, search)
  - Collections (CRUD operations, shelf mappings, auto-assign rules)
  - Conflicts (bulk operations, resolve/dismiss)
  - Devices (registration, approval, shelf management)
  - Highlights (create, update, delete, get)
  - Kobo sync (bookmark, markup, initialization, sync)
  - KOReader sync (library, metadata, bookmarks, progress)
  - Libraries (CRUD, folders, media items, stats)
  - Media items (bulk operations, CRUD)
  - Notes (CRUD operations)
  - OPDS (acquisition, feeds, publication)
  - Progress (reading progress tracking)
  - Queue (device queue management)
  - Ratings (star ratings)
  - Scanner (watch mode, scan operations)
  - Sync protocols (Kobo, KOReader)
  - Users (profile, password, admin operations)
  - WebSocket protocols

- Updated user guides (admin, dashboard, settings, sync)
- Updated device setup guides (Kobo, KOReader)
- Updated developer guides (testing, contributing, operations)
- Updated scripts/README.md
2026-02-27 17:06:22 -05:00

2.5 KiB

Profile Management Guide

Updating Your Profile

Your profile contains your account information and preferences.

How to Update

  1. Click on your username (top-right)
  2. Select Profile from the dropdown
  3. Edit any fields in the "Account Information" section
  4. Click Update Profile
  5. Changes take effect immediately

Fields You Can Update

  • Username - Your login name (must be unique)
  • Email - Your email address (must be unique)
  • First Name - Optional display name
  • Last Name - Optional display name
  • Theme - Your preferred color scheme

Changing Your Password

Regular password changes are recommended for account security.

How to Change

  1. Go to Profile page
  2. Scroll to "Change Password" section
  3. Enter your current password
  4. Enter your new password
  5. Confirm your new password
  6. Click Update Password

Password Requirements

  • Minimum 8 characters
  • Must contain uppercase, lowercase, number, and special character
  • Must match confirmation field
  • Current password must be correct

Deleting Your Account

⚠️ WARNING: This action cannot be undone.

What Gets Deleted

When you delete your account:

  • Your profile information
  • Reading progress and history
  • Device connections
  • Collection preferences
  • All personal data

What Stays

  • Library books (media belongs to the library, not you)
  • System settings
  • Other users' accounts

How to Delete

  1. Go to Profile page
  2. Scroll to "Danger Zone" (bottom of page)
  3. Click Remove My Account
  4. Confirm by clicking "OK" in the popup

Note: If you're the last admin, you cannot delete your account for security reasons.

Theme Options

Personalize your reading experience with different color themes.

Quick Theme Switch

  1. Click the paintbrush icon (top-right, next to your username)
  2. Select a theme from the dropdown
  3. Changes apply instantly

Available Themes

  • Tokyo Night (default) - Blue/purple accents
  • Dracula - Purple/pink tones
  • Nord - Arctic, bluish-gray
  • Solarized Dark - Warm, precise contrast
  • Monokai - Classic vibrant colors
  • One Dark Pro - Atom editor inspired
  • Material Dark - Google Material Design
  • Wood Light - Light wood texture
  • Wood Dark - Dark wood texture
  • Wood Mahogany - Reddish-brown wood

For Admin Users

If you're an administrator, you can also manage other users' profiles from the admin panel.

See Admin User Management for details.