Skip to content

Documentation Audit

Issue Found Severity Affected Page Recommended Fix Status
Missing Coding Tests API detail Medium API Reference Add detailed payload structures for Judge0 integration Open
Voice Architecture WebRTC Reconnects Low Architecture Validate whether WebRTC node transitions trigger full reconnects Open
Job Boards listed in Integrations Low Integrations Ensure Job Boards are clearly marked as 'Planned' Resolved
GitHub alert callouts rendered as plain blockquotes Medium Architecture, Configuration, Proctoring Converted > [!NOTE]-style alerts to MkDocs Material admonitions (!!! note); source-of-truth policy updated to mandate that syntax Resolved
custom theme palette had no color definitions Medium mkdocs.yml Added docs/stylesheets/extra.css and registered it via extra_css. Hex values are placeholders -- swap in the real brand palette Open
Corrupted byte in Windows venv activation command Medium Deployment A literal BEL (0x07) stood where \a belonged, so the command read .venv\Scriptsctivate. Restored to .venv\Scripts\activate Resolved
Deepgram key absent from Configuration Low Configuration, Deployment Added DEEPGRAM_API_KEY; prerequisites now mark Deepgram as needed only for the legacy fallback pipeline Resolved
Voice pipeline count disagreed with its own list Low AI Interviews Page claimed three implementations but listed two; corrected to two. Confirm against code whether a third legacy variant exists (the Documentation Plan says "Pipelines", plural) Open
LIVEKIT_URL provenance unclear Low Configuration Configuration is the only page referencing LiveKit. Verify whether it still backs the WebRTC voice transport, then document it properly or drop the variable Open
FAQ answers duplicated across two pages Low Troubleshooting, FAQs Troubleshooting now links to the FAQs page rather than restating answers; the local-only-run answer moved to FAQs Resolved

Automated validation scripts (link checkers, API spec matchers) should periodically update this file.