docs: fix outdated and incorrect references#2618
Open
dgageot wants to merge 1 commit intodocker:mainfrom
Open
Conversation
A handful of doc pages drifted away from the code. This sweep realigns them with the current behavior: - tools/tasks: the tasks tool stores tasks in a JSON file (not SQLite), defaults to ./tasks.json (not ~/.cagent/tasks.db), and exposes create_task / get_task / update_task / delete_task / list_tasks / next_task / add_dependency / remove_dependency (the old doc only listed four tools and the wrong name add_task). - providers/openai: the WebSocket transport falls back to SSE when --models-gateway is set, not the non-existent --gateway flag. - configuration/models: temperature is provider-dependent up to 2.0 (Anthropic caps at 1.0); frequency_penalty and presence_penalty go from -2.0 to 2.0, not 0.0 to 2.0; the provider list now matches model/provider/aliases.go. - configuration/agents: drop the bogus 'rag' agent property — RAG is wired up via toolsets: - type: rag, ref: <name>, not via a top-level field on the agent. - community/troubleshooting: 'path' is also valid for the tasks toolset and for the agent-level cache block, not just memory. - features/rag: the chunked-embeddings strategy field is 'embedding_model' (matching examples/rag/*.yaml and pkg/rag/strategy/chunked_embeddings.go), not 'model'. Assisted-By: docker-agent
|
❌ PR Review Failed — The review agent encountered an error and could not complete the review. View logs. |
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.
A handful of doc pages had drifted away from the code. This PR realigns them with the current behavior. No code changes — docs only.
What's fixed
docs/tools/tasks/index.md./tasks.jsonrelative to the config dir (not~/.cagent/tasks.db), and exposescreate_task/get_task/update_task/delete_task/list_tasks/next_task/add_dependency/remove_dependency. The old doc only listed four tools and the wrong nameadd_task(vs. actualcreate_task). Also documents priorities and dependencies.docs/providers/openai/index.md--gatewayCLI flag--models-gatewayis set (the actual flag, defined incmd/root/flags.go).docs/configuration/models/index.mdtemperaturerange listed as0.0–1.0;frequency_penaltyandpresence_penaltylisted as0.0–2.0; provider list cut off mid-sentencetemperatureis provider-dependent up to0.0–2.0(Anthropic caps at1.0); penalties run-2.0–2.0; theproviderrow now lists every alias frompkg/model/provider/aliases.goplus a pointer to named providers. The values now match whatdocs/providers/custom/index.mdalready says.docs/configuration/agents/index.mdrag:field on agentsragfield. RAG is attached throughtoolsets: - type: rag, ref: <name>(seeexamples/rag.yaml). Row removed; the schema/example block already mentioned the correct way.docs/community/troubleshooting/index.mdpathfield is only valid formemorytoolsets"pathis also valid on thetaskstoolset and on the agent-levelcacheblock (per thePathfield onToolset/CacheConfiginpkg/config/latest/types.go).docs/features/rag/index.mdchunked-embeddingsstrategy was shown with amodel:fieldembedding_model:— matches every example underexamples/rag/*.yamland the parameter name read bypkg/rag/strategy/chunked_embeddings.go. Fixed in three code blocks and the reference table.Verification
temperature/top_p/ penalty ranges cross-checked withdocs/providers/custom/index.md(which already had the correct ranges) and OpenAI's API reference.pkg/tools/builtin/tasks.go(registered tool names) andpkg/teamloader/registry.go(default path =tasks.json).--models-gatewayflag verified incmd/root/flags.go.embedding_modelfield verified inpkg/rag/strategy/chunked_embeddings.goandexamples/rag/{hybrid,custom_provider,reranking,semantic_embeddings}.yaml.examples/rag.yaml.