docs: Fix critical accuracy issues and improve cross-references#568
Merged
filthyrake merged 1 commit intodevfrom Feb 7, 2026
Merged
docs: Fix critical accuracy issues and improve cross-references#568filthyrake merged 1 commit intodevfrom
filthyrake merged 1 commit intodevfrom
Conversation
Address findings from comprehensive documentation review: Critical fixes: - Fix Worker API auth header name: X-API-Key -> X-Worker-API-Key (API.md) - Fix webhook event names to match WebhookEventType enum across CONFIGURATION.md and ARCHITECTURE.md - Fix database URL default: remove incorrect vlog_password (CONFIGURATION.md) - Fix API key hashing: SHA-256 -> argon2id (CONFIGURATION.md) - Remove nonexistent download endpoints (CONFIGURATION.md, API.md) - Fix settings API paths to match actual routes (CONFIGURATION.md) - Fix worker health check path to /api/v1/health (API.md) - Fix sprite generation endpoint path (API.md) Important fixes: - Fix TAR extraction timeout default: 300 -> 600 (CONFIGURATION.md) - Fix worker offline threshold default: 2 -> 5 (CONFIGURATION.md) - Replace nonexistent VLOG_WORKER_JOB_TIMEOUT with VLOG_WORKER_CLAIM_DURATION - Fix refresh token env var name in AUTHENTICATION.md - Update README.md auth section to feature multi-user auth + RBAC - Replace hardcoded /home/damen/vlog paths with /path/to/vlog Medium fixes: - Add docs/README.md navigation hub organized by audience - Add cross-reference sections to DATABASE.md, AUTHENTICATION.md, TROUBLESHOOTING.md - Add internal doc notice to ISSUE_478_STREAMING_UPLOAD_PROGRESS.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation review identified 20+ issues across 13 doc files. This PR addresses the most impactful findings — critical accuracy errors that would cause functional failures for users following the docs, plus important consistency and navigation improvements.
Critical Fixes (would cause user failures)
X-API-Key→X-Worker-API-Key(workers would get 401s)WebhookEventTypeenum (6 wrong names:video.processing,video.purged,transcription.complete,transcription.failed,worker.connected,worker.disconnected)vlog_password(actual default has no password)/download?quality=,/download?original=true)/api/v1/settings/key/{key},seed-from-env, POST for export)/api/v1/health, sprite endpoint →/sprites/generateImportant Fixes
VLOG_WORKER_JOB_TIMEOUTwith actualVLOG_WORKER_CLAIM_DURATIONVLOG_REFRESH_TOKEN_EXPIRY_DAYS→VLOG_REFRESH_EXPIRY_DAYS/home/damen/vlogwith/path/to/vlogNavigation & Cross-References
Test plan
config.py,worker_auth.py,schemas.pyWebhookEventTypeenum inapi/schemas.pyapi/admin.py🤖 Generated with Claude Code