docs: repository-wide accuracy corrections (doc-vs-code audit, v1.35.0) - #164
Merged
Conversation
Doc-vs-code audit of all 24 docs/ files + README + AGENTS.md (9 sub-agent waves, read-only reviewer profile, max 2 concurrent) plus a dedicated SECURITY.md audit. Every concrete claim (identifiers, flags, defaults, caps, test names, signatures) checked against source; docs-only changes: - SECURITY/PLANNING: stale TestIsPlanMessage refs, ToolCallTaints scope, guard mcp_schema scope, plan-files bounds row, MCP server-mode non_interactive default (read_only), utf16Len claim removed - CONFIG/CLI: phantom ODEK_TOOL_PROGRESS env, --model default (deepseek-v4-flash), repl unknown-flag behavior, serve --no-compaction - SUBAGENTS/MCP/EXTENSIONS: tools table +4, approval keys hash schema+description, per-tool approval for every server, discovery fail-fast, +subagent_spawned/completed events - TELEGRAM/WEBUI/SANDBOXING/README/AGENTS: handler signatures +userID, sandbox default-on posture, stale render Start() symbol, event lists - CHEATSHEET/TOOL_SELECTION/MAINTENANCE/PROVIDERS/DEVELOPMENT: memory actions 6->16, phantom skill agent tools removed, artifacts_max_age_hours, 11 danger classes, docs/ index completed - DOCKER_COMPOSE_USER_GUIDE: corrected to match the docker/ rework
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
odek | 7e3fa8e | Commit Preview URL Branch Preview URL |
Aug 31 2026, 10:51 AM |
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.
Summary
Full doc-vs-code accuracy audit: all 24
docs/files +README.md+AGENTS.md, executed as 9 sub-agent waves (read-onlycode-reviewerprofile, max 2 concurrent) plus a dedicateddocs/SECURITY.mddeep audit. Every concrete claim — identifiers, flags, env vars, defaults, numeric caps, test names, handler signatures — was checked against source. Docs-only; no code changes.Notable corrections
TestIsPlanMessagecitations (test does not exist; mechanism lives inrefreshPlanMessage);ToolCallTaintsis not "shared with skills"; undocumented untoggleablemcp_schemaguard scope; plan-files bounds row (actual:maxTelegramPlanChars = 3800); MCP server-modenon_interactivedefault isread_only, notdeny;utf16Lenclaim removed (counting is byte-based);<system>token requires an override verbODEK_TOOL_PROGRESSenv removed;--modeldefault isdeepseek-v4-flash; repl rejects unknown flags (not silently ignored);servehas no--no-compaction; "every knob has an env counterpart" softenedskill_load/skill_list/artifact_read/list_subagent_profiles),planconditional; approval keys also hash schema+description (sentence was garbled); per-tool approval applies to every server; discovery errors fail fast (not "skip and continue")/plan_resumetakes no args; all 4 handler signatures carry trailinguserID int64--no-sandbox/ODEK_NO_SANDBOXopt-out,ODEK_REQUIRE_SANDBOXfatal); stalerender.Start()symbol; per-tool-approval bullet; event-type lists completed (subagent_spawned/subagent_completed)skill_save/skill_patch/skill_deleteagent tools removed;list_subagent_profiles/artifact_readaddedUnmarshal,max_concurrencyfallback documented,artifacts_max_age_hoursin config reference, 11 danger classes, docs/ index completed (+14 entries), version example fresheneddocker/rework: real layout (context: ..,dockerfile: docker/Dockerfile), 4-stage Dockerfile incl. whisper.cpp/MiniCPM-V stages, 4 odek services + 3 sidecars,read_onlypolicy snippetsVerified clean (no changes needed)
PLANNING.md (post-fix), MEMORY.md, EXTENDED_MEMORY.md, SESSIONS.md, STREAMING.md, CACHING.md, API.md (Go SDK surface), WEBUI.md (auth + all numeric limits), SCHEDULES.md, DAILY-WORKER.md, REDACTION_HARDENING.md.
Verification
TestIsPlanMessagecitations in PLANNING.md missed by a sub-agent pass) which were fixed pre-commit.file:lineevidence from the auditing pass; two auditor false-positives were caught and rejected during triage (sandbox default semantics,max_concurrencydefault 3).Maintainer note (code, not docs)
odek init --globalwrites an explicit"sandbox": falseinto the template while the CLI treats unset as sandbox-wanted-by-default — worth a follow-up look so fresh configs don't silently opt users out of the default-on posture.