docs(providers): Together/Groq/Perplexity cookbook via custom_providers#15214
docs(providers): Together/Groq/Perplexity cookbook via custom_providers#15214perlowja wants to merge 1 commit into
Conversation
CI diagnosisThree failures on this PR. Verified all three are pre-existing master regressions, not introduced by this branch.
|
Three worked recipes for OpenAI-compatible cloud providers, plus the Copilot HTTP 401 auto-recovery info block and the GMI Cloud row in the compatible providers table. All three additions were on the original docs/custom-providers-cookbook branch but its merge base predated 1186 main commits, making the rebase impractical (84k+ line conflict). Replays just the providers.md additions onto current main.
08664ae to
1c0dd51
Compare
|
Force-pushed a clean rebase. The original branch was 1186 commits behind main with an 84k+ line non-trivial diff (the merge base predated all of the Group G contributor renames + most of late-Q1's docs reshape), so rebasing would have produced more noise than the cookbook content. New head |
|
Update: all CI is green at head `1c0dd515` after the rebase pulled in the master fixes I noted yesterday.
This PR is docs-only — single-file, +107 lines to `website/docs/integrations/providers.md` covering Together / Groq / Perplexity custom-provider cookbook, the GMI Cloud row, and a Copilot 401 info block. No runtime change, no schema change. Ready for review when the queue clears. Happy to split into per-section commits if narrower review is preferred. |
What does this PR do?
Adds a Cookbook subsection to
website/docs/integrations/providers.mdunder Named Custom Providers with copy-pasteable recipes for the three most common cloud cases that fit thecustom_providers:pattern: Together AI, Groq, and Perplexity. Plus a "multiple providers in one config" example and a troubleshooting admonition pointing at the three recently merged PRs that made this flow robust.Why this approach: the existing docs describe
custom_providers:in the abstract (local/work/anthropic-proxycombo at lines 1062–1074) and list cloud endpoints generically in the "Other Compatible Providers" table (lines 970–990). But there's no end-to-end recipe for the most common case — "I have a Together AI key, how do I make Hermes use it and be able to switch models with/model?". Users currently have to reconstruct the pattern from three merged PRs (#15083, #15103, #15136). Now that those are onmain, the three-way recipe belongs in the docs so the next user doesn't have to reverse-engineer it.Scope: docs-only. No runtime code, no schema, no tests.
Related Issue
No existing issue — happy to open one first if maintainers prefer that flow. Drafted after using the pattern end-to-end while debugging a skill (InvestorClaw) that needed to point a custom provider at Together AI on Hermes Agent.
Fixes #
Type of Change
Changes Made
website/docs/integrations/providers.md— new subsection### Cookbook: Together AI, Groq, Perplexityinserted immediately after### Named Custom Providers, immediately before### Choosing the Right Setup. Contains:config.yaml+.envfragments.:::tip Troubleshootingadmonition citing fix(cli): validate user-defined providers consistently (salvage #14857) #15083 (CLI validator), fix(runtime): resolve bare custom provider to loopback or CUSTOM_BASE_URL (salvage #14719) #15103 (barecustom+CUSTOM_BASE_URL), and fix(models): consolidated validation + picker — anthropic_messages, native Anthropic, Gemini prefix, OpenAI catalog #15136 (tolerant/v1/modelsprobe).Diff:
1 file changed, 107 insertions(+)— pure addition, no existing content modified.How to Test
This is a docs-only PR; the testable surface is whether the rendered Docusaurus page displays the new subsection correctly. I did not run the full
npm run buildfor the website in this working copy (no local Node toolchain set up for the docs site), relying on the fact that::::tipadmonition (all used elsewhere in this same file, e.g. the:::tip When to set this manuallyblock at line ~1055).If the maintainers would like me to run the Docusaurus build locally before merge, happy to — just flag it in review.
Reproduction of the underlying user pain (what motivated the cookbook): against a fresh
~/.hermes/config.yamlwith only a Together API key, the shortest path from "I have a Together key" to "Hermes is using Together" requires the fullcustom_providers:block +key_env:+model.provider: custom:together+ matching.enventry. Before this PR, none of those pieces are colocated in the docs — a user has to stitch together "Named Custom Providers", "Other Compatible Providers", and the frontmatter of #15083 / #15103 / #15136 to get the complete picture. After this PR, one page section has all of it.Checklist
Code
docs(providers): …)pytest tests/ -qand all tests pass — N/A for a docs-only change. The modified file is not touched by the test suite.Documentation & Housekeeping
docs/, docstrings) — this PR IS the docs update.cli-config.yaml.exampleif I added/changed config keys — N/A (no config-key changes; uses the existingcustom_providers:schema as-shipped by fix(cli): validate user-defined providers consistently (salvage #14857) #15083).CONTRIBUTING.mdorAGENTS.mdif I changed architecture or workflows — N/A.For New Skills
N/A — not a skill addition.
Screenshots / Logs
Raw diff preview (first 30 lines of the 107-line addition):
[… 80 more lines in the same pattern for Groq, Perplexity, the multi-provider example, and the troubleshooting admonition …]