docs: fix 12 verified doc-vs-code inaccuracies - #225
Merged
Conversation
CONFIG.md: drop nonexistent ODEK_MAX_TOOL_PARALLEL env var (env + settings tables); remove orphan stream:true bullet not present in the sample config. MEMORY.md: replace nonexistent --memory-snapshot flow with real subagent memory behavior; correct the 'no memory tool' claim; --interaction -> --interaction-mode. SECURITY.md: --sandbox-volume flag -> sandbox_volumes config key. MIGRATION.md: drop nonexistent --api-key flag. TOOL_SELECTION.md: --continue flag -> odek continue subcommand. TELEGRAM.md: document ODEK_TELEGRAM_DEFAULT_CHAT_ID. WEBUI.md: correct the simplex protocol claim. SESSIONS.md: mark Programmatic API snippet in-module only. AGENTS.md: TestMCPE2E_ -> TestMCPClientE2E_.
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
Fixes 12 verified documentation inaccuracies (13 edits across 9 files) where the docs contradicted the code. Every finding was confirmed against source before editing; every "candidate" that turned out to be accurate was left alone.
Findings
docs/CONFIG.mdODEK_MAX_TOOL_PARALLELenv var (env table + settings table)ODEK_*mapper — proven with a probe test (ODEK_MAX_TOOL_PARALLEL=7→MaxToolParallel = 0)docs/CONFIG.mdstream: truestreamkeydocs/MEMORY.mdodek subagent --memory-snapshot <file>~/.odek/memorystoredocs/MEMORY.md# Memory Context (read-only)═══ MEMORY [N% — X/Y chars] ═══docs/MEMORY.mdmemorytool"toolsfilter;tools.disabledis the controldocs/MEMORY.md--interaction verbose--interaction-mode verbosedocs/SECURITY.md--sandbox-volumeflagsandbox_volumesconfig keydocs/MIGRATION.md--api-keyCLI flagODEK_API_KEYexistsdocs/TOOL_SELECTION.md--continueflagodek continuesubcommanddocs/TELEGRAM.mddefault_chat_idenv var blankODEK_TELEGRAM_DEFAULT_CHAT_IDdocs/WEBUI.mdcancel,subagent_cancel,ping,approval_response,session_switchdocs/SESSIONS.mdinternal/sessionwith no caveatAGENTS.md-run "TestMCPE2E_"-run "TestMCPClientE2E_"Verification
go build ./...+go vet ./...— OKOut of scope (reported, not changed)
Makefiletest-cmdskip patternTestMCPE2Edoes not matchTestMCPClientE2E_*— harmless today (those tests self-skip withoutODEK_E2E). Not a doc issue.RunWithMessagestakes[]session.Message(internal), so the session-oriented API is unreachable from external modules; atype Message = session.Messagealias would close it. Separate decision.