hermes - ✅(Solved) Fix Fallback provider docs show stale/incorrect config paths for fallback_providers [2 pull requests, 1 participants]

Official PRs (…)
ON THIS PAGE

Recommended Tools

×6

Utilities matched from this issue’s tags and category — try them while you read without losing context.

GitHub issue graph ai analysis

Paste a GitHub issue URL. We fetch that issue, discover linked issues from bodies/comments/timeline, collect linked pull requests, and produce a structured English report.

The report is written in English Markdown for sharing and archival.

Helpful · Quick feedback

Loading…
GitHub stats
NousResearch/hermes-agent#19691Fetched 2026-05-05 06:05:29
View on GitHub
Comments
0
Participants
1
Timeline
5
Reactions
0
Author
Participants
Timeline (top)
labeled ×3cross-referenced ×2

Root Cause

The fallback provider implementation migrated to a top-level fallback_providers list while some reference docs still describe the legacy single fallback key or an incorrect nested location.

Fix Action

Fixed

PR fix notes

PR #19790: docs: clarify fallback provider config and docs links

Description (problem / solution / changelog)

Why change

Hermes fallback-provider docs described profile-local config paths inconsistently and made provider/fallback examples harder to follow. While refreshing the existing autonomous docs PR onto current main, the docs build also exposed two small broken-link/anchor warnings on current docs pages.

Files changed

  • website/docs/user-guide/features/fallback-providers.md
  • website/docs/user-guide/configuration.md
  • website/docs/integrations/providers.md
  • website/docs/reference/cli-commands.md
  • website/docs/reference/environment-variables.md
  • website/docs/user-guide/features/kanban.md
  • website/docs/guides/cron-script-only.md
  • website/docs/developer-guide/adding-platform-adapters.md

Verification run

  • npm run lint:diagrams --prefix website
  • npm run build from website/ (passes; no broken-link/anchor warnings after fixes)
  • Diff secret scan for token|password|secret|api_key|private key on added lines: no hits

Risk level

Low. Docs-only clarification and link/anchor cleanup; no runtime code or dependency changes.

Changed files

  • website/docs/developer-guide/adding-platform-adapters.md (modified, +1/-1)
  • website/docs/guides/cron-script-only.md (modified, +4/-13)
  • website/docs/integrations/providers.md (modified, +9/-9)
  • website/docs/reference/cli-commands.md (modified, +1/-1)
  • website/docs/reference/environment-variables.md (modified, +7/-5)
  • website/docs/user-guide/configuration.md (modified, +3/-3)
  • website/docs/user-guide/features/fallback-providers.md (modified, +35/-35)
  • website/docs/user-guide/features/kanban.md (modified, +10/-18)

PR #20033: docs(config): fix fallback provider config paths

Description (problem / solution / changelog)

Fixes #19691

Summary

  • update the environment variable reference to document top-level fallback_providers as the current fallback chain shape
  • clarify that fallback_model is still legacy/backward-compatible, not the recommended config
  • fix the CLI reference so hermes fallback persists to top-level fallback_providers, not under model

Verification

  • rg -n 'fallback_model|fallback_providers|under model|under model' website/docs/reference/environment-variables.md website/docs/reference/cli-commands.md hermes_cli/fallback_cmd.py gateway/run.py\n- git diff --check

Changed files

  • website/docs/reference/cli-commands.md (modified, +1/-1)
  • website/docs/reference/environment-variables.md (modified, +7/-5)

Code Example

fallback_providers:
  - provider: openrouter
    model: anthropic/claude-sonnet-4
RAW_BUFFERClick to expand / collapse

Bug Description

The fallback provider docs describe stale or incorrect config paths for fallback configuration.

The docs currently give two conflicting shapes:

  • fallback_model: as the documented config section in the environment variables reference;
  • fallback_providers: "under model:" in the CLI reference.

The code writes and reads fallback provider chains from top-level fallback_providers, with top-level fallback_model only treated as a legacy format.

Users hand-editing config from the docs can place fallback settings under the wrong key and get confusing failover behavior.

Inspected against main commit af6f9bc2a12682b06fb3632acf5a9cbf01e74a85.

Steps to Reproduce

Static docs/code mismatch:

  1. Open the environment variables reference fallback section.
  2. Open the CLI reference fallback command section.
  3. Compare both against hermes_cli/fallback_cmd.py and gateway/run.py.

Expected Behavior

Docs should consistently document the current config shape:

fallback_providers:
  - provider: openrouter
    model: anthropic/claude-sonnet-4

If fallback_model remains supported, it should be described as legacy/backward-compatible rather than the primary config shape.

Actual Behavior

Docs currently show or describe stale/conflicting paths:

  • fallback_model: as the section to add;
  • fallback_providers: under model:;
  • code actually uses top-level fallback_providers.

Evidence

  • website/docs/reference/environment-variables.md:516-526
    • says to add a fallback_model section.
  • website/docs/reference/cli-commands.md:1066
    • says changes persist to fallback_providers: under model: in config.yaml.
  • hermes_cli/fallback_cmd.py:15-17
    • documents storage as top-level fallback_providers.
  • hermes_cli/fallback_cmd.py:49-54
    • writes config["fallback_providers"] = chain and removes legacy fallback_model.
  • gateway/run.py:2046-2060
    • runtime reads top-level fallback_providers or top-level legacy fallback_model.

Affected Component

Documentation / Configuration

Environment

Static analysis of current main; no local environment-specific behavior required.

Prior Art Checked

I searched existing issues and PRs for:

  • fallback_providers under model
  • fallback_model environment-variables.md
  • fallback providers config.yaml docs

I found related fallback/provider issues, but no exact existing issue for this docs/config-path mismatch.

Root Cause Analysis

The fallback provider implementation migrated to a top-level fallback_providers list while some reference docs still describe the legacy single fallback key or an incorrect nested location.

Proposed Fix

Update the relevant reference docs to:

  • show top-level fallback_providers as the current config shape;
  • mention top-level fallback_model only as legacy/backward-compatible behavior, if desired;
  • remove the wording that says fallback_providers is under model:.

extent analysis

TL;DR

Update the reference documentation to consistently describe the current config shape using top-level fallback_providers.

Guidance

  • Review and update website/docs/reference/environment-variables.md and website/docs/reference/cli-commands.md to reflect the correct config shape.
  • Ensure that fallback_model is documented as legacy/backward-compatible, if it is to be supported.
  • Verify the changes by comparing the updated docs with the code in hermes_cli/fallback_cmd.py and gateway/run.py.
  • Consider adding a note to the documentation to highlight the change and provide guidance for users who may have existing configurations using the legacy format.

Example

fallback_providers:
  - provider: openrouter
    model: anthropic/claude-sonnet-4

This example shows the correct config shape using top-level fallback_providers.

Notes

The proposed fix assumes that the legacy fallback_model format is still supported. If it is not, the documentation should be updated to remove any references to it.

Recommendation

Apply the workaround by updating the reference documentation to reflect the correct config shape, as this will help prevent confusing failover behavior for users who hand-edit their configurations.

Vote matrix · Quick signals

Works
Did the solution work? Tap to confirm.
Easy Fix
Was it a quick fix?
Time Saver
Did it save you time?
Blocking
Was it severely blocking?
Common Issue
Are others likely hitting this too?
Flaky / Intermittent
Is it intermittent?
Verified / Reproducible
Can you reproduce it reliably?
Loading…

Still need to ship something?

×6

Another batch ranked right after the header list — different links, same matching logic.

Back to top recommendations

TRENDING

hermes - ✅(Solved) Fix Fallback provider docs show stale/incorrect config paths for fallback_providers [2 pull requests, 1 participants]