Skip to content

docs: overnight documentation sweep - #54727

Closed
virtuadex wants to merge 1 commit into
NousResearch:mainfrom
virtuadex:docs/overnight-sweep-2026-06-29
Closed

docs: overnight documentation sweep#54727
virtuadex wants to merge 1 commit into
NousResearch:mainfrom
virtuadex:docs/overnight-sweep-2026-06-29

Conversation

@virtuadex

Copy link
Copy Markdown
Contributor

Summary

  • Reviewed the full codebase for documentation drift against origin/main (local main was 308 commits behind; branch created from origin/main).
  • Updated documentation to match current implementation (plugin platform adapters, deferred registry loading, slash-command registry, curator invariants).
  • Saved run progress in /tmp/overnight-docs-sweep.md.

Sweep window

  • From: 2026-06-28 00:00
  • To: 2026-06-29 00:00 (host local TZ)

Recent changes reviewed

Documentation checked

  • hermes_cli/commands.pywebsite/docs/reference/slash-commands.md
  • gateway/platform_registry.py, plugins/platforms/website/docs/developer-guide/gateway-internals.md, SECURITY.md, SECURITY.es.md
  • agent/curator.pywebsite/docs/user-guide/features/curator.md
  • Drift checklist: skills/.../overnight-docs-sweep/references/hermes-agent-drift-checklist.md

Documentation updated

  • website/docs/developer-guide/gateway-internals.md — Key Files table + deferred platform loader behavior
  • website/i18n/zh-Hans/.../gateway-internals.md — Key Files table (en sync)
  • SECURITY.md, SECURITY.es.md — gateway external-surface adapter paths
  • website/docs/reference/slash-commands.md/reasoning full/clamp; CLI-only /prompt, /timestamps
  • website/docs/user-guide/features/curator.md — cron-referenced skills + use_count == 0 grace

Verification

  • git diff --check — passed
  • npm run docs:build — skipped: script not configured
  • npm run build (website/) — failed: docusaurus: not found (node_modules not installed in this environment)

Open questions / risks

  • Operator machine had unrelated dirty apps/desktop/electron/main.cjs — stashed before branching; pop stash on main after sweep.
  • zh-Hans gateway-internals Platform Adapters prose not fully re-translated (Key Files table only).

Autoreview

  • Docs-only diff; no secrets or /tmp paths committed.
  • Claims grounded in commands.py, platform_registry.py, curator.py, and existing gateway-internals Platform Adapters section.

@alt-glitch alt-glitch added type/docs Documentation improvements comp/gateway Gateway runner, session dispatch, delivery P3 Low — cosmetic, nice to have labels Jun 29, 2026

@tonydwb tonydwb left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review Summary

Verdict: LGTM

Documentation sweep covering SECURITY.md updates for plugin architecture, gateway internals table, slash-commands reference, curator docs, and Chinese translation. All changes accurately reflect the current codebase structure.

Looks Good

  • Platform adapter paths correctly updated to plugins/platforms/
  • /reasoning command documentation expanded with full/clamp modes
  • Cron-referenced skills and never-used skill policies documented in curator
  • Deferred loader explanation added to gateway internals

Reviewed by Hermes Agent

@teknium1 teknium1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the focused documentation audit. The deferred-loader and curator updates match current implementation: hermes_cli/plugins.py:1433-1445 registers bundled platform adapters lazily, and agent/curator.py:334-369 protects cron-referenced and recently never-used skills.

Problems

  • website/docs/reference/slash-commands.md documents full / clamp for messaging /reasoning, but the gateway handler only supports display toggles, reset, none, and effort levels (gateway/slash_commands.py:2715-2737). full / clamp are classic-CLI behavior (hermes_cli/cli_commands_mixin.py:2518-2531).

Suggested changes

  • Remove full|clamp from the messaging command row; retain them in the CLI row.

Automated hermes-sweeper review.

@@ -223,7 +223,7 @@ The messaging gateway supports the following built-in commands inside Telegram,
| `/usage` | Show token usage, estimated cost breakdown (input/output), context window state, session duration, and — when available from the active provider — an **Account limits** section with remaining quota / credits pulled live from the provider's API. |
| `/credits` | Show your Nous credit balance and a top-up link that opens the portal billing page in a browser. |
| `/insights [days]` | Show usage analytics. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

full and clamp are not handled by the messaging gateway: gateway/slash_commands.py:2715-2737 accepts show/hide, reset, none, and effort levels only. Please omit these two options from the messaging row; they are implemented by the classic CLI in hermes_cli/cli_commands_mixin.py:2518-2531.

@teknium1 teknium1 added the sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users label Jul 15, 2026
@teknium1

Copy link
Copy Markdown
Contributor

Closing with credit — the curator documentation facts you surfaced here (cron-referenced skills protected from auto-archive, the never-used grace floor) landed via #74190 in their additive form, and the gateway deferred-loader documentation landed via the fresher #72422 variant. The remaining hunks were superseded by #73979. Thanks for the consistent sweeps — this cluster caught real drift!

@teknium1 teknium1 closed this Jul 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp/gateway Gateway runner, session dispatch, delivery P3 Low — cosmetic, nice to have sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants