0 Fork 0

Files

T

John O'Keefe f42720ac64 docs: retire PROJECT_GUIDELINES.md — library-visibility rule now in AGENTS.md + dev docs

PROJECT_GUIDELINES.md had drifted out of reality (podman-only rule
while the stack runs docker; verifier scripts wired to Makefile targets
nobody runs). Trashed it, its two verifier scripts, and the Makefile
targets; the rules that still matched reality (docker runtime, schema
in place until release, server binary only via Docker, services layer,
integration-test pool rules) are absorbed into the new AGENTS.md.

The library-visibility family-lens rule now has a real home:
- AGENTS.md: the standing rule agents auto-discover (new media
  endpoints MUST thread the visible-library set; 403, never silently
  pass; history of the 2026-10-13 leak).
- docs/developer/library-visibility.md: the full explanation (helpers,
  SQL pattern, per-item content gates, series per-library), linked
  from the developer docs index.
Stale doc links updated (docs index, contributing, development).

2026-10-13 20:18:42 -04:00

2.9 KiB

Raw Blame History

Developer Documentation

Welcome to the Bookhoard developer documentation. This section contains API references, protocol specifications, and technical documentation for integrating with Bookhoard.

📚 API Documentation

Complete API Reference

API Reference - Complete REST API reference
- Authentication
- User management
- Libraries
- Media items
- Reading progress
- Notes & highlights
- Analytics
- Book matching
- OPDS
- Sync protocols (KOReader, Kobo)
- WebSocket

Split Endpoint Documentation

Browse individual endpoint documentation with interactive API Explorer:

API Documentation - Split endpoint docs
- Authentication - Register, login, tokens
- Users - Profile management
- Libraries - Library operations
- Media Items - Book/ebook management
- Progress - Reading progress tracking
- Notes - User notes
- Highlights - Book highlights
- Ratings - Book ratings
- Devices - Device management
- Analytics - Usage statistics
- Book Matching - Search and link books
- Collections - Collection management
- OPDS - Open Publication Distribution
- Sync Protocols - KOReader and Kobo sync
- WebSocket - Real-time events

Collections API

Collections API - Complete collections API reference
- Create and manage collections
- Auto-assign rules
- Test rules
- Bulk operations
- Device shelf mappings

🔌 Protocol Specifications

Sync Protocols

Kobo Sync Protocol - Kobo device sync protocol
- Kobo markup sync
- Library fetch
- Authentication
KOReader Sync Protocol - KOReader sync protocol
- Progress sync
- Metadata fetch
- Conflict handling

WebSocket Protocol

WebSocket API - Real-time sync and events
- Connection flow
- Message format
- Event types
- Authentication

🛠 Implementation Guides

Library Visibility

Library Visibility - Per-user library visibility: the family-lens rule. New media endpoints MUST thread the visible-library set (helpers, SQL pattern, series per-library).

Calibre Integration

Calibre OPF Implementation - Technical implementation details
- Architecture and design
- Data structures and functions
- Database schema mapping
- Testing strategy
- Error handling
- Performance considerations

Looking for user documentation? See the User Portal Need to deploy? See the Operations Portal

2.9 KiB Raw Blame History