docs: fix documentation inconsistencies across reference and user guides#1995
Merged
docs: fix documentation inconsistencies across reference and user guides#1995
Conversation
- toolsets-reference: add browser_console to browser + all platform toolsets, add missing hermes-acp, hermes-sms, messaging toolsets, correct hermes-gateway as composite, deduplicate platform toolset listings - tools-reference: add missing vision and web toolset sections - slash-commands: fix /new+/reset as alias (not separate commands), add /stop to CLI section (available in both CLI and gateway), add /plugins command, fix Notes section about messaging-only vs CLI-only - environment-variables: fix HERMES_MAX_ITERATIONS default (90 not 60), add DEEPSEEK_API_KEY/BASE_URL, OPENCODE_ZEN/GO keys, TAVILY_API_KEY, GITHUB_TOKEN, HERMES_EPHEMERAL_SYSTEM_PROMPT - configuration: remove duplicate Alibaba Cloud row, add OpenCode Zen/Go providers - cli-commands: add missing providers to --provider list (opencode-zen, opencode-go, ai-gateway, kilocode, alibaba) - quickstart: add OpenCode Zen and OpenCode Go to provider table
e2436de to
e8286cc
Compare
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
Systematic review of all documentation against the actual codebase. Fixes inconsistencies across 7 doc files.
Changes
toolsets-reference.md
browser_consoletobrowsertoolset and all platform toolsets (was missing)hermes-acptoolset (exists in code, missing from docs)hermes-smstoolset (exists in code, missing from docs)messagingtoolset (exists in code, missing from docs)hermes-gatewayas composite type (union of platform toolsets, not a platform itself)_HERMES_CORE_TOOLS)tools-reference.md
visiontoolset section withvision_analyzetoolwebtoolset section withweb_searchandweb_extracttoolsslash-commands.md
/new+/reset: in code,resetis an alias fornew, not a separate command with different behavior/stopto CLI section (handled in both cli.py and gateway, was only listed under messaging)/pluginscommand (exists in COMMAND_REGISTRY, missing from docs)/stopis not messaging-only,/pluginsis CLI-onlyenvironment-variables.md
HERMES_MAX_ITERATIONSdefault: code says 90, doc said 60DEEPSEEK_API_KEY+DEEPSEEK_BASE_URL(in OPTIONAL_ENV_VARS)OPENCODE_ZEN_API_KEY+OPENCODE_ZEN_BASE_URL(in OPTIONAL_ENV_VARS)OPENCODE_GO_API_KEY+OPENCODE_GO_BASE_URL(in OPTIONAL_ENV_VARS)TAVILY_API_KEY(in OPTIONAL_ENV_VARS, version 10 migration)GITHUB_TOKEN(in OPTIONAL_ENV_VARS)HERMES_EPHEMERAL_SYSTEM_PROMPT(in OPTIONAL_ENV_VARS)configuration.md
cli-commands.md
--providerlist:opencode-zen,opencode-go,ai-gateway,kilocode,alibabaquickstart.md
Verification
All changes verified against actual source code:
toolsets.py,hermes_cli/commands.py,hermes_cli/config.py,hermes_cli/main.py,tools/browser_tool.py,tools/vision_tools.py,tools/web_tools.py,cli.py,gateway/run.py.