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
This commit is contained in:
+91
-183
@@ -1,229 +1,137 @@
|
|||||||
# Bookhoard Documentation Index
|
# Bookhoard Documentation
|
||||||
|
|
||||||
Complete guide to Bookhoard documentation. Find what you need quickly.
|
Complete guide to Bookhoard documentation. Find what you need quickly.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Quick Links
|
## 🚀 By Audience
|
||||||
|
|
||||||
### For New Users
|
### 👤 For End Users
|
||||||
1. [README.md](../README.md) - **Start here!** Project overview and quick start
|
|
||||||
2. [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md) - Understanding and using sync
|
|
||||||
3. [docs/devices/KOBO_SETUP.md](devices/KOBO_SETUP.md) - Kobo e-reader setup
|
|
||||||
4. [docs/devices/KOREADER_SETUP.md](devices/KOREADER_SETUP.md) - KOReader setup
|
|
||||||
|
|
||||||
### For Self-Hosting
|
**[User Documentation Portal](user/INDEX.md)** - Guides for using Bookhoard features
|
||||||
1. [docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md) - Deployment and troubleshooting
|
|
||||||
2. [.env.example](../.env.example) - Secrets configuration (JWT and DB password)
|
|
||||||
|
|
||||||
### For Contributors
|
- **Device Setup**
|
||||||
1. [docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md) - Development workflow and architecture
|
- [Kobo Setup Guide](user/devices/kobo-setup.md) - Complete Kobo e-reader configuration
|
||||||
2. [docs/API_REFERENCE.md](API_REFERENCE.md) - Complete API documentation
|
- [KOReader Setup Guide](user/devices/koreader-setup.md) - KOReader on Kindle/Kobo/PocketBook
|
||||||
3. [docs/COLLECTIONS_API.md](COLLECTIONS_API.md) - Collections API
|
|
||||||
4. [docs/api/WEBSOCKET_API.md](api/WEBSOCKET_API.md) - WebSocket protocol
|
- **Sync Configuration**
|
||||||
|
- [Universal Sync Guide](user/sync-guide.md) - Understanding sync, book matching, conflicts
|
||||||
|
|
||||||
|
- **Frontend & Settings** (Coming Soon)
|
||||||
|
- Frontend Guide
|
||||||
|
- User Areas Guide
|
||||||
|
- Settings Guide
|
||||||
|
- Admin Guide
|
||||||
|
|
||||||
|
### 👨💻 For Developers
|
||||||
|
|
||||||
|
**[Developer Documentation Portal](developer/INDEX.md)** - Technical documentation & API reference
|
||||||
|
|
||||||
|
- **API Documentation**
|
||||||
|
- [Complete API Reference](developer/api-reference.md) - Monolithic REST API reference (1,300+ lines)
|
||||||
|
- [Split Endpoint Docs](developer/api/INDEX.md) - Individual endpoints with interactive API Explorer
|
||||||
|
- [Collections API](developer/collections-api.md) - Collections management API
|
||||||
|
|
||||||
|
- **Protocol Specifications**
|
||||||
|
- [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync
|
||||||
|
- [KOReader Sync Protocol](developer/api/sync/koreader-protocol.md) - KOReader sync
|
||||||
|
- [WebSocket API](developer/websocket-api.md) - Real-time events
|
||||||
|
|
||||||
|
### 🔧 For Operations
|
||||||
|
|
||||||
|
**[Operations Documentation Portal](operations/INDEX.md)** - Deployment & maintenance
|
||||||
|
|
||||||
|
- **Deployment**
|
||||||
|
- [Troubleshooting Guide](operations/troubleshooting.md) - Common deployment issues and solutions
|
||||||
|
|
||||||
|
- **Maintenance** (Coming Soon)
|
||||||
|
- Deployment Guide
|
||||||
|
- Maintenance Guide
|
||||||
|
- Monitoring Guide
|
||||||
|
|
||||||
|
### 🤝 For Contributors
|
||||||
|
|
||||||
|
**[Contributing Portal](contributing/INDEX.md)** - Development workflow
|
||||||
|
|
||||||
|
- [Development Guide](contributing/DEVELOPMENT.md) - Architecture, setup, testing
|
||||||
|
- [PROJECT_GUIDELINES.md](PROJECT_GUIDELINES.md) - Development rules and standards
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📚 Documentation by Topic
|
## 📚 Quick Links
|
||||||
|
|
||||||
### Getting Started
|
| Want to... | Go to |
|
||||||
- **[README.md](../README.md)** - Project overview, features, quick start guide
|
|------------|-------|
|
||||||
- **[docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md)** - Development environment setup
|
| **Get started** | [README.md](../README.md) - Project overview and quick start |
|
||||||
|
| **Set up a device** | [User Portal → Device Setup](user/INDEX.md) |
|
||||||
### Deployment & Operations
|
| **Use the API** | [Developer Portal → API Docs](developer/INDEX.md) |
|
||||||
- **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common deployment issues and solutions
|
| **Deploy Bookhoard** | [Operations Portal → Troubleshooting](operations/troubleshooting.md) |
|
||||||
- **[.env.example](../.env.example)** - Required secrets (JWT_SECRET, DBPASS)
|
| **Contribute code** | [Contributing Portal → Development Guide](contributing/DEVELOPMENT.md) |
|
||||||
- **[docker-compose.yml](../docker-compose.yml)** - Operational configuration with defaults
|
| **Understand sync** | [User Portal → Sync Guide](user/sync-guide.md) |
|
||||||
- **[Makefile](../Makefile)** - Build and test commands
|
|
||||||
|
|
||||||
### Using Sync Features
|
|
||||||
- **[docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md)** - Universal sync user guide
|
|
||||||
- Understanding sync
|
|
||||||
- Book matching and auto-linking
|
|
||||||
- Conflict resolution
|
|
||||||
- Best practices
|
|
||||||
|
|
||||||
### Device Setup
|
|
||||||
- **[docs/devices/KOBO_SETUP.md](devices/KOBO_SETUP.md)** - Kobo e-reader configuration
|
|
||||||
- Device registration
|
|
||||||
- Sync configuration
|
|
||||||
- OPDS wireless book delivery
|
|
||||||
- Troubleshooting
|
|
||||||
|
|
||||||
- **[docs/devices/KOREADER_SETUP.md](devices/KOREADER_SETUP.md)** - KOReader configuration
|
|
||||||
- Installation on Kindle/Kobo/PocketBook
|
|
||||||
- Sync setup
|
|
||||||
- OPDS catalog access
|
|
||||||
- Troubleshooting
|
|
||||||
|
|
||||||
### API Documentation
|
|
||||||
- **[docs/API_REFERENCE.md](API_REFERENCE.md)** - Complete REST API reference
|
|
||||||
- Authentication
|
|
||||||
- User management
|
|
||||||
- Libraries
|
|
||||||
- Media items
|
|
||||||
- Reading progress
|
|
||||||
- Notes & highlights
|
|
||||||
- Analytics
|
|
||||||
- Book matching
|
|
||||||
- OPDS
|
|
||||||
- Sync protocols (KOReader, Kobo)
|
|
||||||
- WebSocket
|
|
||||||
|
|
||||||
- **[docs/COLLECTIONS_API.md](COLLECTIONS_API.md)** - Collections API
|
|
||||||
- Create and manage collections
|
|
||||||
- Auto-assign rules
|
|
||||||
- Test rules
|
|
||||||
- Bulk operations
|
|
||||||
- Device shelf mappings
|
|
||||||
|
|
||||||
- **[docs/api/WEBSOCKET_API.md](api/WEBSOCKET_API.md)** - WebSocket protocol
|
|
||||||
- Connection flow
|
|
||||||
- Message format
|
|
||||||
- Real-time sync broadcasts
|
|
||||||
- Authentication
|
|
||||||
|
|
||||||
### Contributing
|
|
||||||
- **[docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md)** - Development guide
|
|
||||||
- Architecture overview
|
|
||||||
- Directory structure
|
|
||||||
- Local development setup
|
|
||||||
- Testing guidelines
|
|
||||||
- Code style
|
|
||||||
- Deployment
|
|
||||||
|
|
||||||
- **[PROJECT_GUIDELINES.md](../PROJECT_GUIDELINES.md)** - Development rules and standards
|
|
||||||
- Critical prohibitions
|
|
||||||
- Mandatory requirements
|
|
||||||
- Error recovery protocol
|
|
||||||
|
|
||||||
### Reference
|
|
||||||
- **[go.mod](../go.mod)** - Go dependencies
|
|
||||||
- **[database/schema/schema.sql](../database/schema/schema.sql)** - Database schema
|
|
||||||
- **[bruno/](../bruno/)** - API test collections
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📖 Reading Path by Role
|
|
||||||
|
|
||||||
### Self-Hoster / End User
|
|
||||||
**Goal**: Set up and use Bookhoard for reading
|
|
||||||
|
|
||||||
1. Start with [README.md](../README.md) - Understand what Bookhoard is
|
|
||||||
2. Follow quick start in README.md to get running
|
|
||||||
3. Set up your device:
|
|
||||||
- Kobo: [docs/devices/KOBO_SETUP.md](devices/KOBO_SETUP.md)
|
|
||||||
- KOReader: [docs/devices/KOREADER_SETUP.md](devices/KOREADER_SETUP.md)
|
|
||||||
4. Learn about sync: [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md)
|
|
||||||
5. If issues arise: [docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Developer
|
|
||||||
**Goal**: Contribute to Bookhoard or integrate with it
|
|
||||||
|
|
||||||
1. Start with [README.md](../README.md) - Project overview
|
|
||||||
2. Read [docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md) - Architecture and setup
|
|
||||||
3. Review [docs/API_REFERENCE.md](API_REFERENCE.md) - API endpoints
|
|
||||||
4. Check [PROJECT_GUIDELINES.md](../PROJECT_GUIDELINES.md) - Development rules
|
|
||||||
5. Explore codebase and contribute!
|
|
||||||
|
|
||||||
### API Integrator
|
|
||||||
**Goal**: Build integration with Bookhoard
|
|
||||||
|
|
||||||
1. Review [README.md](../README.md) - Feature overview
|
|
||||||
2. Study [docs/API_REFERENCE.md](API_REFERENCE.md) - All endpoints
|
|
||||||
3. Check specialized docs:
|
|
||||||
- Collections: [docs/COLLECTIONS_API.md](COLLECTIONS_API.md)
|
|
||||||
- WebSocket: [docs/api/WEBSOCKET_API.md](api/WEBSOCKET_API.md)
|
|
||||||
- Sync: [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md)
|
|
||||||
4. Test with [bruno/](../bruno/) collections
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🔍 Quick Find
|
## 🔍 Quick Find
|
||||||
|
|
||||||
### "How do I..."
|
### "How do I..."
|
||||||
| ...do this? | See this document |
|
|
||||||
|-------------|------------------|
|
| Question | Answer |
|
||||||
|
|----------|--------|
|
||||||
| ...install Bookhoard? | [README.md](../README.md) - Quick Start |
|
| ...install Bookhoard? | [README.md](../README.md) - Quick Start |
|
||||||
| ...set up my Kobo? | [docs/devices/KOBO_SETUP.md](devices/KOBO_SETUP.md) |
|
| ...set up my Kobo? | [Kobo Setup Guide](user/devices/kobo-setup.md) |
|
||||||
| ...set up KOReader? | [docs/devices/KOREADER_SETUP.md](devices/KOREADER_SETUP.md) |
|
| ...set up KOReader? | [KOReader Setup Guide](user/devices/koreader-setup.md) |
|
||||||
| ...understand sync? | [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md) |
|
| ...understand sync? | [Sync Guide](user/sync-guide.md) |
|
||||||
| ...resolve conflicts? | [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md) - Managing Conflicts |
|
| ...resolve conflicts? | [Sync Guide](user/sync-guide.md) - Managing Conflicts |
|
||||||
| ...match books? | [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md) - Book Matching |
|
| ...troubleshoot deployment? | [Troubleshooting Guide](operations/troubleshooting.md) |
|
||||||
| ...troubleshoot deployment? | [docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md) |
|
| ...use the API? | [API Reference](developer/api-reference.md) |
|
||||||
| ...use the API? | [docs/API_REFERENCE.md](API_REFERENCE.md) |
|
| ...contribute code? | [Development Guide](contributing/DEVELOPMENT.md) |
|
||||||
| ...set up development? | [docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md) |
|
|
||||||
| ...contribute code? | [docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md) - Contributing |
|
|
||||||
|
|
||||||
### "Where is..."
|
### "Where is..."
|
||||||
| ...this information? | See this document |
|
|
||||||
|-------------------|------------------|
|
| Information | Location |
|
||||||
|
|-------------|----------|
|
||||||
| ...features list? | [README.md](../README.md) |
|
| ...features list? | [README.md](../README.md) |
|
||||||
| ...database schema? | [database/schema/schema.sql](../database/schema/schema.sql) |
|
| ...database schema? | [database/schema/schema.sql](../database/schema/schema.sql) |
|
||||||
| ...API endpoints? | [docs/API_REFERENCE.md](API_REFERENCE.md) |
|
| ...API endpoints? | [API Reference](developer/api-reference.md) |
|
||||||
| ...secrets config? | [.env.example](../.env.example) |
|
| ...secrets config? | [.env.example](../.env.example) |
|
||||||
| ...operational config? | [docker-compose.yml](../docker-compose.yml) |
|
| ...operational config? | [docker-compose.yml](../docker-compose.yml) |
|
||||||
| ...deployment issues? | [docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md) |
|
| ...deployment issues? | [Troubleshooting Guide](operations/troubleshooting.md) |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📊 Documentation Statistics
|
## 🎯 Common Workflows
|
||||||
|
|
||||||
| File | Lines | Purpose | Audience |
|
|
||||||
|------|-------|---------|----------|
|
|
||||||
| README.md | 150 | Overview & quick start | Everyone |
|
|
||||||
| contributing/DEVELOPMENT.md | 450 | Development workflow | Contributors |
|
|
||||||
| API_REFERENCE.md | 1,300+ | Complete REST API | Developers, integrators |
|
|
||||||
| COLLECTIONS_API.md | 494 | Collections API | Developers, integrators |
|
|
||||||
| SYNC_USER_GUIDE.md | 350+ | Sync usage guide | End users |
|
|
||||||
| TROUBLESHOOTING.md | 300 | Deployment troubleshooting | Self-hosters |
|
|
||||||
| KOBO_SETUP.md | 598 | Kobo setup | Kobo users |
|
|
||||||
| KOREADER_SETUP.md | 504 | KOReader setup | KOReader users |
|
|
||||||
| WEBSOCKET_API.md | 676 | WebSocket protocol | Developers |
|
|
||||||
| PROJECT_GUIDELINES.md | 250 | Development rules | Developers |
|
|
||||||
|
|
||||||
**Total**: ~5,000 lines of comprehensive documentation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🎯 Common Tasks
|
|
||||||
|
|
||||||
### Set up a new device
|
### Set up a new device
|
||||||
1. Device setup guide: [docs/devices/KOBO_SETUP.md](devices/KOBO_SETUP.md) or [docs/devices/KOREADER_SETUP.md](devices/KOREADER_SETUP.md)
|
1. Choose your device: [Kobo](user/devices/kobo-setup.md) or [KOReader](user/devices/koreader-setup.md)
|
||||||
2. Sync overview: [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md)
|
2. Understand sync: [Sync Guide](user/sync-guide.md)
|
||||||
3. Troubleshooting: Device-specific setup guides
|
3. Troubleshoot: Device-specific guides
|
||||||
|
|
||||||
### Troubleshoot sync issues
|
|
||||||
1. Check [docs/SYNC_USER_GUIDE.md](SYNC_USER_GUIDE.md) - "Managing Conflicts" and "Best Practices"
|
|
||||||
2. Review device-specific guide for common issues
|
|
||||||
3. Check [docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md) for general issues
|
|
||||||
|
|
||||||
### Integrate with Bookhoard API
|
### Integrate with Bookhoard API
|
||||||
1. Start with [docs/API_REFERENCE.md](API_REFERENCE.md) - Complete API reference
|
1. Start with [API Reference](developer/api-reference.md)
|
||||||
2. Check [docs/COLLECTIONS_API.md](COLLECTIONS_API.md) for collections
|
2. Explore [Collections API](developer/collections-api.md)
|
||||||
3. Review [docs/api/WEBSOCKET_API.md](api/WEBSOCKET_API.md) for real-time updates
|
3. Review [WebSocket API](developer/websocket-api.md)
|
||||||
4. Use [bruno/](../bruno/) test collections as examples
|
4. Test with [bruno/](../bruno/) collections
|
||||||
|
|
||||||
### Deploy to production
|
### Deploy to production
|
||||||
1. Follow [README.md](../README.md) quick start
|
1. Follow [README.md](../README.md) quick start
|
||||||
2. Configure environment: [.env.example](../.env.example)
|
2. Configure environment: [.env.example](../.env.example)
|
||||||
3. Review [docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md) for common issues
|
3. Review [Troubleshooting Guide](operations/troubleshooting.md)
|
||||||
4. Check [docs/contributing/DEVELOPMENT.md](contributing/DEVELOPMENT.md) for performance tuning
|
4. Check [Development Guide](contributing/DEVELOPMENT.md) for performance tuning
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📝 Contributing to Documentation
|
## 📝 Contributing to Documentation
|
||||||
|
|
||||||
When adding new features:
|
When adding new features:
|
||||||
1. Update [README.md](../README.md) - Add to features list if user-facing
|
|
||||||
2. Update [docs/API_REFERENCE.md](API_REFERENCE.md) - Document new endpoints
|
1. **User-facing features** → Update relevant User docs
|
||||||
3. Add/update tests in [bruno/](../bruno/)
|
2. **API endpoints** → Update [API Reference](developer/api-reference.md) & split docs
|
||||||
4. Update relevant guides (SYNC_USER_GUIDE.md, device guides, etc.)
|
3. **Backend changes** → Update [Development Guide](contributing/DEVELOPMENT.md)
|
||||||
5. Keep [PROJECT_GUIDELINES.md](../PROJECT_GUIDELINES.md) in mind
|
4. **Deployment changes** → Update [Operations Portal](operations/INDEX.md)
|
||||||
|
|
||||||
|
Keep [PROJECT_GUIDELINES.md](PROJECT_GUIDELINES.md) in mind for documentation standards.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: 2026-02-01
|
**Last Updated**: 2026-02-02
|
||||||
**Bookhoard Version**: 1.0
|
**Bookhoard Version**: 1.0
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# Contributing to Bookhoard
|
||||||
|
|
||||||
|
Welcome to the Bookhoard contributing documentation. This section contains guides for contributing to the Bookhoard project.
|
||||||
|
|
||||||
|
## 🚀 Getting Started
|
||||||
|
|
||||||
|
- **[Development Guide](DEVELOPMENT.md)** - Development workflow and architecture
|
||||||
|
- Architecture overview
|
||||||
|
- Directory structure
|
||||||
|
- Local development setup
|
||||||
|
- Testing guidelines
|
||||||
|
- Code style
|
||||||
|
- Deployment
|
||||||
|
|
||||||
|
## 📋 Project Guidelines
|
||||||
|
|
||||||
|
- **[PROJECT_GUIDELINES.md](../PROJECT_GUIDELINES.md)** - Development rules and standards
|
||||||
|
- Critical prohibitions
|
||||||
|
- Mandatory requirements
|
||||||
|
- Error recovery protocol
|
||||||
|
- Workflow checklists
|
||||||
|
|
||||||
|
## 🤝 How to Contribute
|
||||||
|
|
||||||
|
We welcome contributions! Please see our [Development Guide](DEVELOPMENT.md) for information on:
|
||||||
|
- Setting up your development environment
|
||||||
|
- Understanding the codebase
|
||||||
|
- Making pull requests
|
||||||
|
- Code review process
|
||||||
|
- Testing requirements
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Looking for user documentation?** See the [User Portal](../user/INDEX.md)
|
||||||
|
**Need API docs?** See the [Developer Portal](../developer/INDEX.md)
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
# 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](api-reference.md)** - 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](api/INDEX.md)** - Split endpoint docs
|
||||||
|
- [Authentication](api/authentication/) - Register, login, tokens
|
||||||
|
- [Users](api/users/) - Profile management
|
||||||
|
- [Libraries](api/libraries/) - Library operations
|
||||||
|
- [Media Items](api/media-items/) - Book/ebook management
|
||||||
|
- [Progress](api/progress/) - Reading progress tracking
|
||||||
|
- [Notes](api/notes/) - User notes
|
||||||
|
- [Highlights](api/highlights/) - Book highlights
|
||||||
|
- [Ratings](api/ratings/) - Book ratings
|
||||||
|
- [Devices](api/devices/) - Device management
|
||||||
|
- [Analytics](api/analytics/) - Usage statistics
|
||||||
|
- [Book Matching](api/book-matching/) - Search and link books
|
||||||
|
- [Collections](api/collections/) - Collection management
|
||||||
|
- [OPDS](api/opds/) - Open Publication Distribution
|
||||||
|
- [Sync Protocols](api/sync/) - KOReader and Kobo sync
|
||||||
|
- [WebSocket](api/websocket/) - Real-time events
|
||||||
|
|
||||||
|
### Collections API
|
||||||
|
|
||||||
|
- **[Collections API](collections-api.md)** - 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](api/sync/kobo-protocol.md)** - Kobo device sync protocol
|
||||||
|
- Kobo markup sync
|
||||||
|
- Library fetch
|
||||||
|
- Authentication
|
||||||
|
|
||||||
|
- **[KOReader Sync Protocol](api/sync/koreader-protocol.md)** - KOReader sync protocol
|
||||||
|
- Progress sync
|
||||||
|
- Metadata fetch
|
||||||
|
- Conflict handling
|
||||||
|
|
||||||
|
### WebSocket Protocol
|
||||||
|
|
||||||
|
- **[WebSocket API](websocket-api.md)** - Real-time sync and events
|
||||||
|
- Connection flow
|
||||||
|
- Message format
|
||||||
|
- Event types
|
||||||
|
- Authentication
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Looking for user documentation?** See the [User Portal](../user/INDEX.md)
|
||||||
|
**Need to deploy?** See the [Operations Portal](../operations/INDEX.md)
|
||||||
@@ -15,7 +15,7 @@ Complete reference for Bookhoard REST API endpoints.
|
|||||||
- [Devices](devices/) - Device registration and sync
|
- [Devices](devices/) - Device registration and sync
|
||||||
- [Analytics](analytics/) - Usage statistics
|
- [Analytics](analytics/) - Usage statistics
|
||||||
- [Book Matching](book-matching/) - Search and link books
|
- [Book Matching](book-matching/) - Search and link books
|
||||||
- [Collections](collections/) - See [COLLECTIONS_API.md](../COLLECTIONS_API.md)
|
- [Collections](collections/) - See [Collections API](../collections-api.md)
|
||||||
- [OPDS](opds/) - Open Publication Distribution
|
- [OPDS](opds/) - Open Publication Distribution
|
||||||
- [Sync Protocols](sync/) - KOReader and Kobo sync
|
- [Sync Protocols](sync/) - KOReader and Kobo sync
|
||||||
- [WebSocket](websocket/) - Real-time sync events
|
- [WebSocket](websocket/) - Real-time sync events
|
||||||
@@ -64,7 +64,7 @@ See [Book Matching](book-matching/)
|
|||||||
|
|
||||||
## Collections
|
## Collections
|
||||||
|
|
||||||
See [Collections API](../COLLECTIONS_API.md) or [Collections Endpoints](collections/)
|
See [Collections API](../collections-api.md) or [Collections Endpoints](collections/)
|
||||||
|
|
||||||
## OPDS
|
## OPDS
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# Collections API
|
# Collections API
|
||||||
|
|
||||||
See [COLLECTIONS_API.md](../../COLLECTIONS_API.md) for complete collections documentation.
|
See [Collections API](../../collections-api.md) for complete collections documentation.
|
||||||
|
|
||||||
## Quick Links
|
## Quick Links
|
||||||
|
|
||||||
@@ -31,5 +31,5 @@ Collections allow you to organize your books into custom groups with automatic a
|
|||||||
|
|
||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
- [COLLECTIONS_API.md](../../COLLECTIONS_API.md) - Complete API reference
|
- [Collections API](../../collections-api.md) - Complete API reference
|
||||||
- [Sync Guide](../../SYNC_USER_GUIDE.md) - How collections sync to devices
|
- [Sync Guide](../../user/sync-guide.md) - How collections sync to devices
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# Operations Documentation
|
||||||
|
|
||||||
|
Welcome to the Bookhoard operations documentation. This section contains guides for deploying, maintaining, and troubleshooting Bookhoard instances.
|
||||||
|
|
||||||
|
## 🔧 Deployment
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
|
1. **[Troubleshooting Guide](troubleshooting.md)** - Common deployment issues and solutions
|
||||||
|
- Environment variables setup
|
||||||
|
- Port conflicts
|
||||||
|
- Container runtime (Podman)
|
||||||
|
- Network configuration
|
||||||
|
- Performance optimization
|
||||||
|
|
||||||
|
### Additional Deployment Guides
|
||||||
|
|
||||||
|
**[Deployment Guide](deployment.md)** - Comprehensive deployment guide
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
## 🛠️ Maintenance
|
||||||
|
|
||||||
|
**[Maintenance Guide](maintenance.md)** - Ongoing operations and maintenance
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
## 📊 Monitoring
|
||||||
|
|
||||||
|
**[Monitoring Guide](monitoring.md)** - Monitoring and alerting
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Looking for user documentation?** See the [User Portal](../user/INDEX.md)
|
||||||
|
**Need API docs?** See the [Developer Portal](../developer/INDEX.md)
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# User Documentation
|
||||||
|
|
||||||
|
Welcome to the Bookhoard user documentation. This section contains guides for using Bookhoard features, setting up devices, and configuring sync.
|
||||||
|
|
||||||
|
## 📱 Device Setup
|
||||||
|
|
||||||
|
Learn how to configure your e-reader devices to sync with Bookhoard:
|
||||||
|
|
||||||
|
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Complete guide for Kobo e-readers
|
||||||
|
- Device registration
|
||||||
|
- Sync configuration
|
||||||
|
- OPDS wireless book delivery
|
||||||
|
- Troubleshooting
|
||||||
|
|
||||||
|
- **[KOReader Setup Guide](devices/koreader-setup.md)** - Complete guide for KOReader
|
||||||
|
- Installation on Kindle/Kobo/PocketBook
|
||||||
|
- Sync setup
|
||||||
|
- OPDS catalog access
|
||||||
|
- Troubleshooting
|
||||||
|
|
||||||
|
## 🔄 Sync Configuration
|
||||||
|
|
||||||
|
- **[Universal Sync Guide](sync-guide.md)** - Understanding and using sync features
|
||||||
|
- What is Universal Sync?
|
||||||
|
- Supported devices
|
||||||
|
- Book matching and auto-linking
|
||||||
|
- Conflict resolution
|
||||||
|
- Best practices
|
||||||
|
|
||||||
|
## 🎨 Frontend Guide
|
||||||
|
|
||||||
|
**[Frontend Guide](frontend-guide.md)** - Learn how to use the Bookhoard web interface
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
## 👤 User Areas
|
||||||
|
|
||||||
|
**[User Areas Guide](user-areas.md)** - Managing your personal library and settings
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
## ⚙️ Settings
|
||||||
|
|
||||||
|
**[Settings Guide](settings-guide.md)** - Configuring your Bookhoard preferences
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
## 🔐 Admin Features
|
||||||
|
|
||||||
|
**[Admin Guide](admin-guide.md)** - Administrative functions and management
|
||||||
|
- *Coming Soon*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Looking for developer documentation?** See the [Developer Portal](../developer/INDEX.md)
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# Admin Guide
|
||||||
|
|
||||||
|
**Coming Soon**
|
||||||
|
|
||||||
|
This guide will cover:
|
||||||
|
- User management
|
||||||
|
- Library management
|
||||||
|
- System monitoring
|
||||||
|
- Analytics and reporting
|
||||||
|
- Security settings
|
||||||
|
- Backup and restore
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*In the meantime, check out our [Operations Portal](../operations/)*
|
||||||
@@ -560,9 +560,9 @@ To improve sync speed:
|
|||||||
## Additional Resources
|
## Additional Resources
|
||||||
|
|
||||||
- [Kobo Developer Documentation](https://help.kobo.com/hc/en-us)
|
- [Kobo Developer Documentation](https://help.kobo.com/hc/en-us)
|
||||||
- [Bookhoard Universal Sync Guide](UNIVERSAL_SYNC_IMPLEMENTATION_GUIDE.md)
|
- [Bookhoard Universal Sync Guide](../sync-guide.md)
|
||||||
- [KOReader Setup Guide](KOBOREADER_SETUP.md)
|
- [KOReader Setup Guide](koreader-setup.md)
|
||||||
- [Bookhoard API Reference](API_REFERENCE.md)
|
- [Bookhoard API Reference](../../developer/api-reference.md)
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
@@ -485,8 +485,8 @@ OPDSCompressionEnabled = true
|
|||||||
|
|
||||||
- [KOReader Documentation](https://github.com/koreader/koreader)
|
- [KOReader Documentation](https://github.com/koreader/koreader)
|
||||||
- [KOReader Forum](https://www.mobileread.com/forums/forumdisplay.php?f=271)
|
- [KOReader Forum](https://www.mobileread.com/forums/forumdisplay.php?f=271)
|
||||||
- [Bookhoard Universal Sync Guide](UNIVERSAL_SYNC_IMPLEMENTATION_GUIDE.md)
|
- [Bookhoard Universal Sync Guide](../sync-guide.md)
|
||||||
- [Kobo Setup Guide](KOBO_SETUP.md)
|
- [Kobo Setup Guide](kobo-setup.md)
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# Frontend Guide
|
||||||
|
|
||||||
|
**Coming Soon**
|
||||||
|
|
||||||
|
This guide will cover:
|
||||||
|
- Navigating the Bookhoard web interface
|
||||||
|
- Browsing and searching your library
|
||||||
|
- Managing collections
|
||||||
|
- Viewing reading progress
|
||||||
|
- Using notes and highlights
|
||||||
|
- Personalizing your experience
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*In the meantime, check out our [Device Setup Guides](devices/)*
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Settings Guide
|
||||||
|
|
||||||
|
**Coming Soon**
|
||||||
|
|
||||||
|
This guide will cover:
|
||||||
|
- Account settings
|
||||||
|
- Display preferences (themes, fonts)
|
||||||
|
- Sync configuration
|
||||||
|
- Device management
|
||||||
|
- Privacy options
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*In the meantime, check out our [Device Setup Guides](devices/)*
|
||||||
@@ -73,8 +73,8 @@
|
|||||||
|
|
||||||
For detailed device configuration instructions, see the appropriate setup guide:
|
For detailed device configuration instructions, see the appropriate setup guide:
|
||||||
|
|
||||||
- **[Kobo Setup Guide](devices/KOBO_SETUP.md)** - Kobo e-reader configuration
|
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Kobo e-reader configuration
|
||||||
- **[KOReader Setup Guide](devices/KOREADER_SETUP.md)** - KOReader configuration
|
- **[KOReader Setup Guide](devices/koreader-setup.md)** - KOReader configuration
|
||||||
|
|
||||||
### Quick Overview
|
### Quick Overview
|
||||||
|
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# User Areas Guide
|
||||||
|
|
||||||
|
**Coming Soon**
|
||||||
|
|
||||||
|
This guide will cover:
|
||||||
|
- Managing your personal library
|
||||||
|
- Uploading and organizing books
|
||||||
|
- Creating and managing collections
|
||||||
|
- Syncing across devices
|
||||||
|
- Personal settings
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*In the meantime, check out our [Sync Guide](sync-guide.md)*
|
||||||
@@ -247,10 +247,11 @@ func (h *HTTPHandler) APIHome(c echo.Context) error {
|
|||||||
TOC: []templates.TOCItem{},
|
TOC: []templates.TOCItem{},
|
||||||
Breadcrumb: []templates.BreadcrumbItem{
|
Breadcrumb: []templates.BreadcrumbItem{
|
||||||
{Title: "Docs", URL: "/docs"},
|
{Title: "Docs", URL: "/docs"},
|
||||||
|
{Title: "Developer", URL: "/docs/developer"},
|
||||||
{Title: "API Reference", URL: ""},
|
{Title: "API Reference", URL: ""},
|
||||||
},
|
},
|
||||||
Category: "API Reference",
|
Category: "API Reference",
|
||||||
SourceFile: "API_REFERENCE.md",
|
SourceFile: "developer/api-reference.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
var buf bytes.Buffer
|
var buf bytes.Buffer
|
||||||
|
|||||||
+11
-11
@@ -100,22 +100,22 @@ func (h *DocsHandler) getDocTitle(docPath string) string {
|
|||||||
switch filename {
|
switch filename {
|
||||||
case "INDEX.md":
|
case "INDEX.md":
|
||||||
return "Documentation Index"
|
return "Documentation Index"
|
||||||
case "API_REFERENCE.md":
|
case "developer/api-reference.md":
|
||||||
return "API Reference"
|
return "API Reference"
|
||||||
case "TROUBLESHOOTING.md":
|
case "developer/collections-api.md":
|
||||||
|
return "Collections API"
|
||||||
|
case "developer/websocket-api.md":
|
||||||
|
return "WebSocket API"
|
||||||
|
case "operations/troubleshooting.md":
|
||||||
return "Troubleshooting"
|
return "Troubleshooting"
|
||||||
case "SYNC_USER_GUIDE.md":
|
case "user/sync-guide.md":
|
||||||
return "Sync Guide"
|
return "Sync Guide"
|
||||||
|
case "user/devices/kobo-setup.md":
|
||||||
|
return "Kobo Setup"
|
||||||
|
case "user/devices/koreader-setup.md":
|
||||||
|
return "KOReader Setup"
|
||||||
case "DEVELOPMENT.md":
|
case "DEVELOPMENT.md":
|
||||||
return "Development Guide"
|
return "Development Guide"
|
||||||
case "WEBSOCKET_API.md":
|
|
||||||
return "WebSocket API"
|
|
||||||
case "COLLECTIONS_API.md":
|
|
||||||
return "Collections API"
|
|
||||||
case "KOBO_SETUP.md":
|
|
||||||
return "Kobo Setup"
|
|
||||||
case "KOREADER_SETUP.md":
|
|
||||||
return "KOReader Setup"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return title
|
return title
|
||||||
|
|||||||
Reference in New Issue
Block a user