docs(fallback): document the actual config shape (top-level fallback_providers) (#19691)#20516
Closed
0xsir0000 wants to merge 1 commit into
Closed
Conversation
…providers) (NousResearch#19691) The fallback-providers user-guide page was leading with the legacy ``fallback_model:`` (singular dict) shape across nine YAML examples, the intro paragraph, the custom-endpoint section, the auxiliary cross-reference, and the summary table. The CLI-reference page already showed the correct top-level ``fallback_providers:`` list shape, and ``hermes_cli/fallback_cmd.py`` + ``cli.py`` only persist to that key — so users hand-editing config from the docs ended up with a key the writer never updates and the reader treats as legacy back-compat only. The intro line under ``hermes fallback`` also wrongly said the chain persists under ``model.fallback_providers`` — the writer has never put it nested under ``model:``; the deep-merge config loader silently ignored the misplaced key, producing the confusing failover behaviour the issue describes. Rewrite the page to: - lead with ``fallback_providers:`` (top-level list) as the primary shape, - add a worked "multiple fallbacks tried in order" example so the list format's value is obvious, - update the custom-endpoint, auxiliary, and summary-table snippets to use the same shape, - correct the ``hermes fallback`` intro to "top-level ``fallback_providers:`` list ... not nested under ``model:``", - keep the ``fallback_providers`` vs ``fallback_model`` admonition (now flipped — current shape first, legacy shape second), and refresh the env- var tip and "main provider only valid in ..." prose to mention both keys. Also touch ``configuration.md`` (the auxiliary-section cross-reference and two ``"main"``-only-valid-in-X notes) so it stops pointing readers back at the legacy key. Fixes NousResearch#19691
Collaborator
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.
Summary
The fallback-providers user-guide page was leading with the legacy `fallback_model:` (singular dict) shape across nine YAML examples, the intro paragraph, the custom-endpoint section, the auxiliary cross-reference, and the summary table. The CLI-reference page already showed the correct top-level `fallback_providers:` list shape, and `hermes_cli/fallback_cmd.py` + `cli.py` only persist to that key — so users hand-editing config from the docs ended up with a key the writer never updates and the reader treats as legacy back-compat only.
The intro line under `hermes fallback` also wrongly said the chain persists under `model.fallback_providers` — the writer has never put it nested under `model:`; the deep-merge config loader silently ignored the misplaced key, producing the confusing failover behaviour the issue describes.
Fix
Rewrite the page to:
Also touch `configuration.md` (the auxiliary-section cross-reference and two `"main"`-only-valid-in-X notes) so it stops pointing readers back at the legacy key.
Verification
Fixes #19691