Reconcile docs with current functionality (audit fixes) - #36
Merged
Conversation
A full docs audit against the codebase surfaced drift across reference, architecture, getting-started, guides, and how-to pages. Fixes: - reference/api: correct meter-frame audit perm; add claim-next-group, controller-settings, channel-rooms, agent-release, profile/watchdog create, and /readyz endpoints. - reference/configuration: document the agent-update-check env family, RAKKR_AUTH_FALLBACK_GRACE_MS, RAKKR_RECORDING_CACHE_MAX_BYTES, and RAKKR_OIDC_ALLOW_INSECURE_ISSUER. - reference/tasks: add helm:check, node:test-db, nodes:check-lifecycle, release. - reference/metrics + recorder-agent: correlation/source labels; add RAKKR_CAPTURE_CHUNK_SECONDS and --version. - architecture: reflect the module refactor (schema.ts/index.ts barrels, requirePermission in index-authorization.ts, app.onError), migration count. - getting-started/concepts: add the provisioning node status; describe upload destinations + policies (not the legacy "upload provider"). - guides: fix the audio-enhancement filter-chain order (denoise first). - how-to: correct console labels (Add …), the Edit-access dialog, Health-page actions, watchdog speech-mode, channel-map target flow, job statuses, etc. Also two real bugs found in passing: - web: room-detail delete-refusal message said "nodes" but the 409 is raised for schedules (nodes are SET NULL). - shared: enhancement.ts chain comment was stale (denoise order / missing lowpass). Gates: node:check/lint/format, check:loc, all 14 baseline verifiers, docs build (54 pages), and node tests all pass. Co-Authored-By: Claude Opus 4.8 <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
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.
Full documentation audit of all 73 doc pages against the current codebase (routes, RBAC catalog, DB schema, config/env, metrics, mise tasks, agent CLI, console pages). This PR fixes the drift that was found. The large majority of pages were already accurate; changes are concentrated where reality had moved.
Reference
—→node:control; addclaim-next-group, controller-settings (GET/PATCH /settings/controller),PUT …/channel-rooms,GET /nodes/agent-release, profile/watchdogPOSTcreate, andGET /readyz.RAKKR_AGENT_RELEASE_*,RAKKR_GITHUB_*),RAKKR_AUTH_FALLBACK_GRACE_MS,RAKKR_RECORDING_CACHE_MAX_BYTES,RAKKR_OIDC_ALLOW_INSECURE_ISSUER.helm:check,node:test-db,nodes:check-lifecycle, and thereleasetask.peer_channel/phaselabels and the listen-monitorsourcelabel.RAKKR_CAPTURE_CHUNK_SECONDS/--capture-chunk-secondsand--version.Architecture
schema.tsandshared/src/index.tsare re-export barrels;requirePermissionis created inindex-authorization.ts; a globalapp.onErrormaps DB-unavailable→503 / else→500. Migration count0039→0046. Overview diagram now lists the 6th (switcher-routing) runner.Getting-started / guides
provisioningnode status; replace the legacy "upload provider" glossary with destinations + policies (list fan-out).How-to (console label/behavior drift)
Corrected: recording-profiles (removed the non-existent "Enabled" toggle; "Chunk Length"), channel-maps (target-agnostic template; real Mode names; "Promote"), manage-users ("Edit access" = roles/groups/scopes; "Add user"), "Add group"/"Add schedule", health-alert inline actions (Ack / Mute 1h), watchdog speech-mode not console-editable, node status vocab, install one-liner
--site/--room, room "node inventory", "Requested channels are already in use", and the recording-job status list (noclaimedstatus; addstop_requested).Two code bugs found in passing
apps/web/src/pages/room-detail.tsx— delete-refusal message said the room "still has nodes assigned," but the 409 is raised for schedules (nodes are SET NULL). Corrected both the toast and the confirm dialog.packages/shared/src/enhancement.ts— stale enhancement-chain comment (denoise order / missing low-pass).Verification
node:check,node:lint,node:format-check,check:loc, all 14 baseline verifiers,docs:build(54 pages, no MDX/link errors), andnode:testall pass locally.Scope note:
docs/internal/audits/*(historical) anddocs/internal/design/*(point-in-time) were not line-audited;docs/internal/baselines/*are machine-verified by theverify-*-baseline.mjsgates.🤖 Generated with Claude Code