Files

T

john-okeefe 253f56399d 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

1.8 KiB

Raw Blame History

Link Book

Link a device book to a Bookhoard media item. Supports bulk linking.

Endpoint: POST /api/sync/bulk-link-books or POST /api/sync/auto-link-books Auth: Required Content-Type: application/json

Manual Link Request Body

Field	Type	Required	Description
links	array	Yes	List of book links
links[].unlinked_book_id	string	Yes	Device book UUID
links[].media_item_id	string	Yes	Bookhoard media item UUID
links[].confidence_score	float	No	Match confidence (0-1)

Example Manual Link Request

{
  "links": [
    {
      "unlinked_book_id": "uuid-1",
      "media_item_id": "uuid-2",
      "confidence_score": 1.0
    }
  ]
}

Auto-Link Request Body

Field	Type	Required	Description
confidence_threshold	float	No	Minimum confidence for auto-link (default: 0.8)
limit	integer	No	Maximum books to auto-link (default: 50)

Example Auto-Link Request

{
  "confidence_threshold": 0.8,
  "limit": 50
}

Response (200 OK) - Manual Link

{
  "results": [
    {
      "unlinked_book_id": "uuid-1",
      "status": "success",
      "media_item_id": "uuid-2"
    }
  ],
  "total": 1,
  "successful": 1,
  "failed": 0
}

Response (200 OK) - Auto-Link

{
  "auto_linked": 15,
  "results": [
    {
      "unlinked_book_id": "uuid-1",
      "title": "The Hobbit",
      "matched_media_item_id": "uuid-2",
      "confidence": 0.95,
      "match_method": "sha256_match"
    }
  ]
}

Error Responses

Code	Description
400	Invalid link data
401	Invalid or expired token
404	Media item not found

1.8 KiB Raw Blame History