John O'Keefe
913174cdf8
TestDocsRelativeLinks walked only docs/developer; widening it to all of docs/ immediately surfaced the same class of rot the gate was built for, outside its old reach: - docs/index.md was the old monolith's landing page: linked the deleted api-reference.md, 10 directory-style area links, and escaped the docs tree to README/AGENTS/.env/compose. Rewritten as a portal whose every link resolves, with one representative endpoint doc per API area and pointers to the new writing-ui-docs.md standard. - directory-style links in user stubs (devices/, ../operations/) - case-mismatched links (Development.md) in contributing.md - monolith-era pointer (API_REFERENCE.md, TROUBLESHOOTING.md) and escaped AGENTS.md links in contributing/development.md - docs/development/calibre-opf-implementation.md double-up escapes, a link to the removed repo-root plan file (absorbed here), and a source-code hyperlink the docs site can't serve (now inline code) - operations/operations.md linked three never-written guide pages as aspirational links - they stay plain text until pages exist HANDS-OFF (project owner, 2026-11-02): docs/user/filters/** and docs/user/searching-and-filtering.md are exempt as link sources so no future checker failure can force edits to the filter documentation. Files linking INTO them remain checked.
38 lines
903 B
Markdown
38 lines
903 B
Markdown
# 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** - Comprehensive deployment guide
|
|
|
|
- _Coming Soon_
|
|
|
|
## 🛠️ Maintenance
|
|
|
|
**Maintenance Guide** - Ongoing operations and maintenance
|
|
|
|
- _Coming Soon_
|
|
|
|
## 📊 Monitoring
|
|
|
|
**Monitoring Guide** - Monitoring and alerting
|
|
|
|
- _Coming Soon_
|
|
|
|
---
|
|
|
|
**Looking for user documentation?** See the [User Portal](../user/user-guide.md)
|
|
**Need API docs?** See the [Developer Portal](../developer/development.md)
|