From 67bd90feecd1a938f35d429bc50a03b1e6e8c438 Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Mon, 2 Feb 2026 08:51:37 -0500 Subject: [PATCH] docs: create API documentation index and structure Phase 2 part 1: Add API documentation landing page - Create docs/api/INDEX.md with quick links - Organize by category (auth, users, libraries, media items, etc.) - Provide navigation to all API endpoint documentation - Link to COLLECTIONS_API.md for collections details --- docs/api/INDEX.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 docs/api/INDEX.md diff --git a/docs/api/INDEX.md b/docs/api/INDEX.md new file mode 100644 index 0000000..ea3a1a4 --- /dev/null +++ b/docs/api/INDEX.md @@ -0,0 +1,79 @@ +# API Documentation + +Complete reference for Bookhoard REST API endpoints. + +## Quick Links + +- [Authentication](authentication/) - User registration, login, tokens +- [Users](users/) - Profile management +- [Libraries](libraries/) - Library management +- [Media Items](media-items/) - Book/ebook operations +- [Progress](progress/) - Reading progress tracking +- [Notes](notes/) - User notes management +- [Highlights](highlights/) - Book highlights +- [Ratings](ratings/) - Book ratings +- [Devices](devices/) - Device registration and sync +- [Analytics](analytics/) - Usage statistics +- [Book Matching](book-matching/) - Search and link books +- [Collections](collections/) - See [COLLECTIONS_API.md](../COLLECTIONS_API.md) +- [OPDS](opds/) - Open Publication Distribution +- [Sync Protocols](sync/) - KOReader and Kobo sync +- [WebSocket](websocket/) - Real-time sync events + +--- + +## Authentication + +See [Authentication Endpoints](authentication/) + +## Users & Profiles + +See [User Management](users/) + +## Libraries + +See [Library Management](libraries/) + +## Media Items + +See [Media Item Operations](media-items/) + +## Reading Progress + +See [Progress Tracking](progress/) + +## Notes & Highlights + +See [Notes Management](notes/) and [Highlights Management](highlights/) + +## Ratings + +See [Ratings System](ratings/) + +## Device Management + +See [Device Registration & Sync](devices/) + +## Analytics + +See [Usage Analytics](analytics/) + +## Book Matching & Linking + +See [Book Matching](book-matching/) + +## Collections + +See [Collections API](../COLLECTIONS_API.md) or [Collections Endpoints](collections/) + +## OPDS + +See [OPDS Feeds](opds/) + +## Sync Protocols + +See [KOReader Sync](sync/) and [Kobo Sync](sync/) + +## WebSocket + +See [WebSocket Protocol](websocket/)