Skip to content

docs: fix 12 verified doc-vs-code inaccuracies - #225

Merged
jkyberneees merged 1 commit into
mainfrom
fix/docs-accuracy
Sep 9, 2026
Merged

docs: fix 12 verified doc-vs-code inaccuracies#225
jkyberneees merged 1 commit into
mainfrom
fix/docs-accuracy

Conversation

@jkyberneees

Copy link
Copy Markdown
Contributor

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

Doc Wrong Correct
docs/CONFIG.md ODEK_MAX_TOOL_PARALLEL env var (env table + settings table) No such env var, and no generic ODEK_* mapper — proven with a probe test (ODEK_MAX_TOOL_PARALLEL=7MaxToolParallel = 0)
docs/CONFIG.md Pinned-keys note referenced stream: true Sample config has no stream key
docs/MEMORY.md Subagents inherit a read-only facts snapshot via odek subagent --memory-snapshot <file> No such flag; subagents read the shared ~/.odek/memory store
docs/MEMORY.md Prompt header # Memory Context (read-only) Real header ═══ MEMORY [N% — X/Y chars] ═══
docs/MEMORY.md "Subagents do NOT get a memory tool" Registered under the same tools filter; tools.disabled is the control
docs/MEMORY.md --interaction verbose --interaction-mode verbose
docs/SECURITY.md --sandbox-volume flag sandbox_volumes config key
docs/MIGRATION.md --api-key CLI flag Only ODEK_API_KEY exists
docs/TOOL_SELECTION.md --continue flag odek continue subcommand
docs/TELEGRAM.md default_chat_id env var blank ODEK_TELEGRAM_DEFAULT_CHAT_ID
docs/WEBUI.md "simplex prompt → stream → done flow" Bidirectional — doc itself documents cancel, subagent_cancel, ping, approval_response, session_switch
docs/SESSIONS.md Programmatic API snippet imported internal/session with no caveat Marked in-module only, with the public-API pointer
AGENTS.md -run "TestMCPE2E_" -run "TestMCPClientE2E_"

Verification

  • Per-finding assertion gate (stale text absent, corrected text present) — exit 0
  • Doc scanner: 154 links, 0 broken; no missing repo paths; every referenced Go symbol exists
  • go build ./... + go vet ./...OK

Out of scope (reported, not changed)

  • Makefile test-cmd skip pattern TestMCPE2E does not match TestMCPClientE2E_* — harmless today (those tests self-skip without ODEK_E2E). Not a doc issue.
  • RunWithMessages takes []session.Message (internal), so the session-oriented API is unreachable from external modules; a type Message = session.Message alias would close it. Separate decision.

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_.
@jkyberneees
jkyberneees merged commit ac68101 into main Sep 9, 2026
10 checks passed
@jkyberneees
jkyberneees deleted the fix/docs-accuracy branch September 9, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant