Skip to content

docs: deep audit — registry drift, stale claims, 2-week PR coverage, dashboard screenshot#40952

Merged
teknium1 merged 1 commit into
mainfrom
hermes/hermes-29a5f95b
Jun 7, 2026
Merged

docs: deep audit — registry drift, stale claims, 2-week PR coverage, dashboard screenshot#40952
teknium1 merged 1 commit into
mainfrom
hermes/hermes-29a5f95b

Conversation

@teknium1

@teknium1 teknium1 commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Deep audit of the hand-written docs against the current codebase, plus a 2-week merged-PR coverage sweep and one live dashboard screenshot. 43 doc pages corrected + 1 screenshot added.

Method: built canonical-source registries (COMMAND_REGISTRY, PROVIDER_REGISTRY, TOOLSETS, tools.registry, DEFAULT_CONFIG), ran diff-coverage checks, then 7 parallel read-only audit agents (one per docs section) wrote findings to disk; every load-bearing claim was re-verified against source before patching. The 149 feat: PRs merged in the last 2 weeks were swept for docs gaps.

What was wrong (highlights)

Registry drift (reference/)

  • /version slash command, context_engine toolset, openai-api/novita-ai --provider choices all missing
  • tool count ~64~71; model_catalog.ttl_hours 241 (real default)
  • profile describe missing from summary table; missing real provider env vars (LM_API_KEY, KIMI_CODING_API_KEY, ALIBABA_CODING_PLAN_*, ANTHROPIC_BASE_URL, COPILOT_API_BASE_URL)
  • faq said "Windows: not natively" — native Windows is supported via the PowerShell installer

Broken commands / stale facts (user-guide/)

  • hermes -w -q (no such top-level flag → -z), hermes logs --tail (→ -f)
  • display.language listed 8 of 16 values; auxiliary slots "8" → actual 11
  • docker.md "separate dashboard container not supported" contradicts repo's own compose
  • gateway-streaming "disabled by default" → per-platform (Telegram on, Discord off)

Features

  • curator "never touches bundled skills" is false (prune_builtins: true default) + missing CLI verbs
  • codex-runtime aux keys (context_compressioncompression, vision_detectvision)
  • kanban terminate endpoint + 5 CLI verbs + per-profile cap; mcp mTLS; api-server run-approval endpoint; built-in-plugins missing nemo_relay/teams_pipeline
  • StepFun step-3-ministep-3.5-flash; web-search backends 4→8; tool-gateway image-model IDs; voice-mode STT/TTS enums; phantom rl toolset removed

Developer-guide

  • build-a-plugin flagship code examples (wrong register_command signature, ContextEngine/ImageGenProvider/MemoryProvider ABCs); entry-point group hermes.pluginshermes_agent.plugins; PLUGIN.yamlplugin.yaml; phantom crawl() method; stale LOC count

Messaging

  • WeCom typing/streaming columns; telegram transport default editauto; sms host default; simplex/ntfy gateway setup + pairing-approve commands; line smart-chunking; matrix MATRIX_DM_AUTO_THREAD

2-week PR coverage

  • desktop.md refreshed for ~15 shipped features with zero prior docs footprint (zh-Hans UI switcher, rebindable shortcuts + zoom + Cmd+K, status-bar model picker + YOLO toggle, session-by-id + archive, concurrent multi-profile + cross-profile @session, composer history, Providers pane, per-profile remote hosts, Grok OAuth launcher, aux-pin warning)
  • Dashboard / kanban / MCP / skills-hub / Portal / CLI core / security / api-server features shipped in the window were verified already documented in companion docs: PRs

Media

New /img/dashboard/admin-config.png — the dashboard Config admin page, captured live from a fresh clean profile (no secrets, no personalization), embedded in web-dashboard.md.

Validation

Result
Files changed 43 docs + 1 screenshot
docusaurus build --locale en [SUCCESS] (exit 0)
New broken links/anchors 0 (all warnings pre-existing in auto-generated skill pages)
Skill catalog regen not needed (no new bundled/optional skills in window)

Out of scope: the zh-Hans i18n mirror still has the old step-3-mini string (separate translation corpus, syncs on next translation pass); auto-generated skill catalog pages (regenerate on build).

Infographic

Hermes Docs Deep Audit

…dashboard screenshot

Full-corpus correctness audit of the hand-written docs against the codebase,
plus a 2-week merged-PR coverage sweep and one live dashboard screenshot.

Correctness (verified against COMMAND_REGISTRY / PROVIDER_REGISTRY / TOOLSETS /
tools.registry / DEFAULT_CONFIG / source):
- reference: add /version slash command, context_engine toolset, openai-api +
  novita-ai to --provider; fix tool count 64->71; model_catalog ttl 24->1;
  add profile describe to summary table; add real provider env vars
  (LM_API_KEY/LM_BASE_URL, KIMI_CODING_API_KEY, ALIBABA_CODING_PLAN_*,
  ANTHROPIC_BASE_URL, COPILOT_API_BASE_URL); fix faq "Windows: not natively".
- user-guide: fix broken `hermes -w -q` (->-z) and `hermes logs --tail` (->-f);
  language list 8->16; aux slots 8->11; docker separate-dashboard claim;
  _SECURITY_ARGS -> _BASE_SECURITY_ARGS.
- features: curator prune_builtins truth + missing CLI verbs; codex-runtime aux
  keys (context_compression->compression, vision_detect->vision); kanban
  terminate endpoint + promote/reassign/schedule/diagnostics/edit + per-profile
  cap; mcp mTLS (client_cert/client_key); built-in-plugins nemo_relay +
  teams_pipeline; api-server run approval endpoint; computer-use frontmatter.
- features N-Z + integrations: StepFun step-3-mini->step-3.5-flash; web-search
  backends 4->8; tool-gateway image-model IDs; voice-mode STT/TTS enums; remove
  phantom `rl` toolset; nous-portal status subcommand.
- messaging: WeCom typing/streaming cols; telegram transport default edit->auto;
  sms host default; simplex/ntfy `gateway setup` + pairing approve; line
  smart-chunking; matrix MATRIX_DM_AUTO_THREAD.
- developer-guide: build-a-plugin code examples (register_command signature,
  ContextEngine/ImageGenProvider/MemoryProvider ABCs); model-provider-plugin
  entry-point group hermes.plugins->hermes_agent.plugins; PLUGIN.yaml->plugin.yaml;
  agent-loop stale LOC; web-search-provider phantom crawl().

PR coverage (2-week window, 149 feat PRs):
- desktop.md refreshed for ~15 shipped features (zh-Hans switcher, rebindable
  shortcuts + zoom + Cmd+K, status-bar model picker + YOLO toggle, session-by-id
  + archive, multi-profile concurrent + cross-profile @session, composer history,
  Providers pane, per-profile remote hosts, Grok OAuth, aux-pin warning).
- configuration.md gateway-streaming default corrected to per-platform.
- tool-gateway.md free tool pool entitlement note.

Media:
- New /img/dashboard/admin-config.png — live dashboard Config admin page
  (captured from a clean profile, no secrets/personalization).
@alt-glitch alt-glitch added type/docs Documentation improvements P3 Low — cosmetic, nice to have labels Jun 7, 2026
@teknium1 teknium1 merged commit 2d099fe into main Jun 7, 2026
18 checks passed
@teknium1 teknium1 deleted the hermes/hermes-29a5f95b branch June 7, 2026 08:39
teknium1 added a commit that referenced this pull request Jun 7, 2026
Mirrors the EN deep-audit fixes (PR #40952) into the zh-Hans translation so the
two locales agree. zh-Hans is the only non-English locale; 26 translated pages
carried the same stale claims.

Corrections ported (code tokens identical across locales; prose re-translated
where the surrounding text was already Chinese):
- reference: /version slash command + dual-surface list; cli --provider adds
  openai-api + novita aliases; tool count 70->71 (+ removed phantom "10 RL tools"
  and fixed kanban 7->9); model_catalog ttl 24->1.
- user-guide: hermes -w -q -> -w -z; language list 8->16; aux slots 8->11;
  docker separate-dashboard claim; gateway-streaming per-platform note;
  computer-use frontmatter.
- features: curator prune_builtins truth; codex-runtime aux keys
  (context_compression->compression, vision_detect->vision); voice-mode STT/TTS
  enums; removed phantom rl toolset.
- integrations: StepFun step-3-mini->step-3.5-flash; web-search backends 4->8;
  nous-portal status subcommand.
- messaging: WeCom typing/streaming columns; telegram transport default
  edit->auto; sms host 0.0.0.0->127.0.0.1; simplex/ntfy gateway-setup + pairing
  approve; line smart-chunking; matrix MATRIX_DM_AUTO_THREAD; msgraph host note.
- developer-guide: entry-point group hermes.plugins->hermes_agent.plugins;
  PLUGIN.yaml->plugin.yaml.

Net-new EN sections (mcp mTLS, api-server run-approval, kanban CLI verbs) are
untranslated in zh-Hans and fall back to English source, consistent with the
mirror's existing partial-coverage state. Verified: docusaurus build --locale
zh-Hans succeeds; no new broken anchors from these edits.
changman pushed a commit to changman/hermes-agent that referenced this pull request Jun 10, 2026
…dashboard screenshot (NousResearch#40952)

Full-corpus correctness audit of the hand-written docs against the codebase,
plus a 2-week merged-PR coverage sweep and one live dashboard screenshot.

Correctness (verified against COMMAND_REGISTRY / PROVIDER_REGISTRY / TOOLSETS /
tools.registry / DEFAULT_CONFIG / source):
- reference: add /version slash command, context_engine toolset, openai-api +
  novita-ai to --provider; fix tool count 64->71; model_catalog ttl 24->1;
  add profile describe to summary table; add real provider env vars
  (LM_API_KEY/LM_BASE_URL, KIMI_CODING_API_KEY, ALIBABA_CODING_PLAN_*,
  ANTHROPIC_BASE_URL, COPILOT_API_BASE_URL); fix faq "Windows: not natively".
- user-guide: fix broken `hermes -w -q` (->-z) and `hermes logs --tail` (->-f);
  language list 8->16; aux slots 8->11; docker separate-dashboard claim;
  _SECURITY_ARGS -> _BASE_SECURITY_ARGS.
- features: curator prune_builtins truth + missing CLI verbs; codex-runtime aux
  keys (context_compression->compression, vision_detect->vision); kanban
  terminate endpoint + promote/reassign/schedule/diagnostics/edit + per-profile
  cap; mcp mTLS (client_cert/client_key); built-in-plugins nemo_relay +
  teams_pipeline; api-server run approval endpoint; computer-use frontmatter.
- features N-Z + integrations: StepFun step-3-mini->step-3.5-flash; web-search
  backends 4->8; tool-gateway image-model IDs; voice-mode STT/TTS enums; remove
  phantom `rl` toolset; nous-portal status subcommand.
- messaging: WeCom typing/streaming cols; telegram transport default edit->auto;
  sms host default; simplex/ntfy `gateway setup` + pairing approve; line
  smart-chunking; matrix MATRIX_DM_AUTO_THREAD.
- developer-guide: build-a-plugin code examples (register_command signature,
  ContextEngine/ImageGenProvider/MemoryProvider ABCs); model-provider-plugin
  entry-point group hermes.plugins->hermes_agent.plugins; PLUGIN.yaml->plugin.yaml;
  agent-loop stale LOC; web-search-provider phantom crawl().

PR coverage (2-week window, 149 feat PRs):
- desktop.md refreshed for ~15 shipped features (zh-Hans switcher, rebindable
  shortcuts + zoom + Cmd+K, status-bar model picker + YOLO toggle, session-by-id
  + archive, multi-profile concurrent + cross-profile @session, composer history,
  Providers pane, per-profile remote hosts, Grok OAuth, aux-pin warning).
- configuration.md gateway-streaming default corrected to per-platform.
- tool-gateway.md free tool pool entitlement note.

Media:
- New /img/dashboard/admin-config.png — live dashboard Config admin page
  (captured from a clean profile, no secrets/personalization).
changman pushed a commit to changman/hermes-agent that referenced this pull request Jun 10, 2026
…ch#41104)

Mirrors the EN deep-audit fixes (PR NousResearch#40952) into the zh-Hans translation so the
two locales agree. zh-Hans is the only non-English locale; 26 translated pages
carried the same stale claims.

Corrections ported (code tokens identical across locales; prose re-translated
where the surrounding text was already Chinese):
- reference: /version slash command + dual-surface list; cli --provider adds
  openai-api + novita aliases; tool count 70->71 (+ removed phantom "10 RL tools"
  and fixed kanban 7->9); model_catalog ttl 24->1.
- user-guide: hermes -w -q -> -w -z; language list 8->16; aux slots 8->11;
  docker separate-dashboard claim; gateway-streaming per-platform note;
  computer-use frontmatter.
- features: curator prune_builtins truth; codex-runtime aux keys
  (context_compression->compression, vision_detect->vision); voice-mode STT/TTS
  enums; removed phantom rl toolset.
- integrations: StepFun step-3-mini->step-3.5-flash; web-search backends 4->8;
  nous-portal status subcommand.
- messaging: WeCom typing/streaming columns; telegram transport default
  edit->auto; sms host 0.0.0.0->127.0.0.1; simplex/ntfy gateway-setup + pairing
  approve; line smart-chunking; matrix MATRIX_DM_AUTO_THREAD; msgraph host note.
- developer-guide: entry-point group hermes.plugins->hermes_agent.plugins;
  PLUGIN.yaml->plugin.yaml.

Net-new EN sections (mcp mTLS, api-server run-approval, kanban CLI verbs) are
untranslated in zh-Hans and fall back to English source, consistent with the
mirror's existing partial-coverage state. Verified: docusaurus build --locale
zh-Hans succeeds; no new broken anchors from these edits.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low — cosmetic, nice to have type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants