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:
2026-02-02 15:58:34 -05:00
parent ece90c0f1f
commit 253f56399d
76 changed files with 372 additions and 207 deletions
+2 -1
View File
@@ -247,10 +247,11 @@ func (h *HTTPHandler) APIHome(c echo.Context) error {
TOC: []templates.TOCItem{},
Breadcrumb: []templates.BreadcrumbItem{
{Title: "Docs", URL: "/docs"},
{Title: "Developer", URL: "/docs/developer"},
{Title: "API Reference", URL: ""},
},
Category: "API Reference",
SourceFile: "API_REFERENCE.md",
SourceFile: "developer/api-reference.md",
}
var buf bytes.Buffer
+11 -11
View File
@@ -100,22 +100,22 @@ func (h *DocsHandler) getDocTitle(docPath string) string {
switch filename {
case "INDEX.md":
return "Documentation Index"
case "API_REFERENCE.md":
case "developer/api-reference.md":
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"
case "SYNC_USER_GUIDE.md":
case "user/sync-guide.md":
return "Sync Guide"
case "user/devices/kobo-setup.md":
return "Kobo Setup"
case "user/devices/koreader-setup.md":
return "KOReader Setup"
case "DEVELOPMENT.md":
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