Audit: contradictions and duplicates across docs and code comments #56
Notifications
Due Date
No due date set.
Blocks
#59 Glossary: pin down domain terms in CONTEXT.md
haylan/LLM-Server
#60 Target doc structure
haylan/LLM-Server
Reference: haylan/LLM-Server#56
Reference in new issue
Block a user
Part of #55
Question
Check every factual claim in README.md, docs/ (excluding docs/research/), and comments in docker-compose.yml, .env.example, scripts/ against the actual source. For each: verdict true / false (what the source says instead) / duplicate-of (where else it's stated). AFK. Output: a table in the resolution comment.
Resolution: audit of docs and code comments against source
Scope: README.md, docs/ (excluding research/ and agents/), comments in docker-compose.yml, .env.example, scripts/*.sh, checked against compose/scripts as of
8ae3210. Verdicts: TRUE / FALSE / DUPLICATE / STALE / REMOVED-FEATURE (ComfyUI / Qwen-Image / Open WebUI, not audited in depth). Line refs are for this audit only; they don't belong in docs.Headline findings
OMNIROUTE_DASHBOARD_PORTto the host. Four places say it never is.OMNIROUTE_PORT:-4000doesn't exist. Compose publishesOMNIROUTE_API_PORT1:1, so it's 20129:20129 by default with no 4000 mapping. Every client doc and .env.example still point at 4000.README.md
git pull, syncs non-blank config values from .env.example with a conflict prompt (--forcein non-interactive runs), resolves the GPU GIDs, and downloads the classifier model and the ComfyUI filesexposeonly. See the cluster "llama-server has no host port"${OMNIROUTE_PORT:-4000}/v1OMNIROUTE_API_PORT(default 20129) 1:1OMNIROUTE_DASHBOARD_PORTto the hostdocs/network-access.md
${LLAMA_PORT:-8080}expose) and isn't published at all, so "LAN-only" understates it: it isn't on the LAN either${OMNIROUTE_PORT:-4000}OMNIROUTE_API_PORTdocs/proxy-key-onboarding.md
OPENWEBUI_OMNIROUTE_KEY. True once it's removed. DUPLICATE of update.sh's key-minting commentPOST /api/keysneeds a session, not verified (#37)http://<host>:<OMNIROUTE_DASHBOARD_PORT>works directly. Thedocker inspecttemplate is also wrong: it uses.Networks.ai_stack, but the network is namedai-stackand Compose prefixes it with the project name (e.g.llm-server_ai-stack)docs/proxy-request-priority.md
docs/coding-cli-setup/*
${OMNIROUTE_PORT:-4000}OMNIROUTE_API_PORT(20129 by default). Occurs about 12 timesqwen3.8-27b-localnaming--jinja, already set--jinjaREQUEST_TIMEOUT_MS, and the 60s was most likely the per-connectiontimeoutMs. Pick one wording--n-gpu-layers 28is set, but the comment gives no reason for it--parallel 1, 65536 ctx, qwen-code transcript capsdocs/server-planing.md
docker-compose.yml (comments)
test -fguard.env.example (comments)
OMNIROUTE_PORTis published at 4000 and mapped onto API_PORT; the dashboard is never publishedOMNIROUTE_API_PORT:OMNIROUTE_API_PORTand publishes the dashboard/key/generateequivalent; mint by hand (#37)/key/generateis LiteLLM vocabularyscripts/update.sh (comments)
--force; blank secrets go through set_if_blankscripts/switch-model.sh
Outside scope, noticed in passing
.gitignorecomment refers toscripts/ingest-memory.sh, which doesn't exist (STALE). The file also has.qwen/tmpwithout a trailing newline.Duplicate clusters
OMNIROUTE_PORT:-4000(STALE): README:AI gateway · network-access:AI gateway · .env.example:OmniRoute block · coding-cli-setup index (endpoints and table), claude-code, kimi-cli, opencode, qwen-code (x4).--jinjarequired: claude-code.md · opencode.md.