docs: fix wrong model defaults, fabricated CLI commands, and stale references#1298
Open
kovtcharov wants to merge 1 commit into
Open
docs: fix wrong model defaults, fabricated CLI commands, and stale references#1298kovtcharov wants to merge 1 commit into
kovtcharov wants to merge 1 commit into
Conversation
…ale references Several docs described commands and defaults that don't exist in the code, so users copy-pasting them hit errors and contributors trusted wrong values. The chat/global default model is Gemma-4-E4B-it-GGUF, but CLAUDE.md, the LLM SDK doc, the Chat SDK doc, and the EMR guide all claimed Qwen variants (CLAUDE.md even contradicted itself). docs/reference/cli.mdx documented six commands that were never implemented (`gaia mcp add`/`remove`, `visualize`, `groundtruth`, `batch-experiment`, `eval -f`) plus wrong defaults (sd model, download/Lemonade ports) and a duplicate Kill section. CLAUDE.md's structure tree, agent table, tool-mixin table, and CLI list had drifted from the code, and the code guide falsely claimed Python generation was removed. Changes: - Default model corrected to Gemma-4-E4B-it-GGUF across CLAUDE.md, llm.mdx, chat.mdx, and emr.mdx (EMR VLM included); per-agent table now matches code. - cli.mdx: removed the six fabricated commands, fixed sd/download/Lemonade defaults, added the `npu` init profile, dropped the stale duplicate Kill section, and documented previously-missing real commands (summarize, jira, docker, telegram). - CLAUDE.md: structure tree, agent table, and KNOWN_TOOLS table synced to the real source; GaiaAgent rename marked planned (not done); CLI list corrected. - code.mdx: Python generation documented as still supported (it's the default). - agent-ui.mdx: Lemonade port 13305 and a broken in-page anchor fixed. - AGENTS.md: removed the stale "currently active PR #606" note (merged). - Removed the orphaned duplicate guides/telegram.mdx (superseded by telegram-adapter.mdx).
github-actions
Bot
added
documentation
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
1 participant
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.
A repo-wide doc audit found documentation that actively misleads users and contributors.
docs/reference/cli.mdxdocumented six commands that don't exist (gaia mcp add/remove,visualize,groundtruth,batch-experiment,eval -f) — anyone copy-pasting them hits an error — plus wrong defaults (SD model,download/Lemonade ports) and a duplicate Kill section. The chat/global default model isGemma-4-E4B-it-GGUF, but CLAUDE.md, the LLM and Chat SDK docs, and the EMR guide all claimed Qwen variants (CLAUDE.md contradicted itself). The code guide falsely stated Python generation was removed (it's still the default), CLAUDE.md's structure/agent/tool tables had drifted from the source, andagent-ui.mdxshowed the wrong Lemonade port. After this PR the docs match the code.This is the documentation half of the audit; the code-hygiene + test-coverage findings ship separately.
Test plan
python -c "import json; json.load(open('docs/docs.json'))"— nav still valid JSONgrep -rE "gaia (mcp add|mcp remove|visualize|groundtruth|batch-experiment)" docs/reference/cli.mdx— returns nothinggaia sd -h(SDXL-Turbo),gaia download -h(port 13305),gaia init -h(npuprofile present)grep -rn "GaiaAgent" src/gaia— still zero matches, confirming the "planned, not done" wording is correct