docs(providers): write LLM provider configuration guide and provider selection strategy documentation #8930

Open
opened 2026-04-14 04:04:08 +00:00 by HAL9000 · 1 comment
Owner

Background and Context

Epic #5174 (Additional LLM Provider Integrations — Gemini, Mistral, Local Models) has implemented GeminiProvider (#5256) and OllamaProvider/MistralProvider (#5257). The final deliverable for this Epic is comprehensive documentation that helps users understand how to configure each provider, when to choose one over another, and how to troubleshoot common issues.

Without clear documentation, users cannot effectively use the new providers even if the implementation is correct. The documentation must cover configuration keys, authentication, model selection, and cost implications.

This issue blocks Epic #5174.

Acceptance Criteria

  • docs/reference/providers.md is updated with sections for Gemini, Mistral, and Ollama providers
  • Each provider section covers: authentication, configuration keys, supported models, and example config
  • A provider selection guide is added explaining trade-offs (cost, latency, capability, privacy)
  • Troubleshooting section covers common errors (invalid API key, model not found, rate limits)
  • Documentation is reviewed and approved by a maintainer
  • All configuration key examples are validated against the actual config schema

Subtasks

  • Write Gemini provider section (API key, model selection, quota limits)
  • Write Mistral provider section (API key, model selection, endpoint configuration)
  • Write Ollama provider section (local setup, model download, endpoint configuration)
  • Write provider selection guide (cost vs. capability vs. privacy matrix)
  • Write troubleshooting section for common provider errors
  • Validate all config key examples against the actual schema

Definition of Done

  • All acceptance criteria met
  • Tests written and passing (coverage >= 97%)
  • Code reviewed and approved
  • Documentation updated if needed
  • No regressions introduced

Metadata

  • Commit message: docs(providers): write LLM provider configuration guide and provider selection strategy
  • Branch name: docs/providers-configuration-guide

Automated by CleverAgents Bot
Agent: new-issue-creator

## Background and Context Epic #5174 (Additional LLM Provider Integrations — Gemini, Mistral, Local Models) has implemented `GeminiProvider` (#5256) and `OllamaProvider`/`MistralProvider` (#5257). The final deliverable for this Epic is comprehensive documentation that helps users understand how to configure each provider, when to choose one over another, and how to troubleshoot common issues. Without clear documentation, users cannot effectively use the new providers even if the implementation is correct. The documentation must cover configuration keys, authentication, model selection, and cost implications. This issue blocks Epic #5174. ## Acceptance Criteria - [ ] `docs/reference/providers.md` is updated with sections for Gemini, Mistral, and Ollama providers - [ ] Each provider section covers: authentication, configuration keys, supported models, and example config - [ ] A provider selection guide is added explaining trade-offs (cost, latency, capability, privacy) - [ ] Troubleshooting section covers common errors (invalid API key, model not found, rate limits) - [ ] Documentation is reviewed and approved by a maintainer - [ ] All configuration key examples are validated against the actual config schema ## Subtasks - [ ] Write Gemini provider section (API key, model selection, quota limits) - [ ] Write Mistral provider section (API key, model selection, endpoint configuration) - [ ] Write Ollama provider section (local setup, model download, endpoint configuration) - [ ] Write provider selection guide (cost vs. capability vs. privacy matrix) - [ ] Write troubleshooting section for common provider errors - [ ] Validate all config key examples against the actual schema ## Definition of Done - [ ] All acceptance criteria met - [ ] Tests written and passing (coverage >= 97%) - [ ] Code reviewed and approved - [ ] Documentation updated if needed - [ ] No regressions introduced ## Metadata - **Commit message:** `docs(providers): write LLM provider configuration guide and provider selection strategy` - **Branch name:** `docs/providers-configuration-guide` --- **Automated by CleverAgents Bot** Agent: new-issue-creator
HAL9000 added this to the v3.6.0 milestone 2026-04-14 04:06:40 +00:00
Author
Owner

Verified — LLM provider documentation is a v3.6.0 deliverable. MoSCoW: Should-have. Priority: Medium.


Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor

✅ **Verified** — LLM provider documentation is a v3.6.0 deliverable. MoSCoW: Should-have. Priority: Medium. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
cleveragents/cleveragents-core#8930
No description provided.