Skip to content

docs: replace ASCII diagrams and clarify fallback config - #21594

Open
camaragon wants to merge 1 commit into
NousResearch:mainfrom
camaragon:auto/hermes-self-improvement
Open

docs: replace ASCII diagrams and clarify fallback config#21594
camaragon wants to merge 1 commit into
NousResearch:mainfrom
camaragon:auto/hermes-self-improvement

Conversation

@camaragon

@camaragon camaragon commented May 8, 2026

Copy link
Copy Markdown
Contributor

Why change

Replace remaining docs ASCII diagrams with supported Mermaid and clarify fallback configuration without losing legacy compatibility guidance.

Files changed

  • cron-script-only.md: replace the no-agent execution diagram with Mermaid.
  • kanban.md: replace the GUI architecture diagram with Mermaid and show the actual DB persistence -> FastAPI/WebSocket tail -> React UI boundary.
  • providers.md: clarify that fallback routing has no environment variables, preserve legacy fallback_model compatibility, and recommend fallback_providers for new configuration.

Verification run

  • full Docusaurus build — passed for English and zh-Hans
  • full ASCII guard — passed
  • touched-file ASCII guard — passed
  • git diff --check — passed

Risk level

Low. Docs-only changes; no runtime code or dependency changes.

@alt-glitch alt-glitch added type/docs Documentation improvements P3 Low — cosmetic, nice to have area/config Config system, migrations, profiles comp/gateway Gateway runner, session dispatch, delivery labels May 8, 2026
@camaragon
camaragon force-pushed the auto/hermes-self-improvement branch 11 times, most recently from 5056668 to 5819a03 Compare May 15, 2026 17:16
@camaragon
camaragon force-pushed the auto/hermes-self-improvement branch 12 times, most recently from f63dab5 to 319a506 Compare May 22, 2026 09:02
@camaragon
camaragon force-pushed the auto/hermes-self-improvement branch 2 times, most recently from d009280 to 9f6b584 Compare May 24, 2026 05:59

@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 cleanup. One correction is needed during salvage.

Problems

  • website/docs/user-guide/features/kanban.md:511 changes the architecture to DB --> UI, but live updates are delivered by the FastAPI /events WebSocket, which tails task_events (plugins/kanban/dashboard/plugin_api.py:10-11, :2379). The previous diagram named that WebSocket path; the Mermaid replacement drops it.

Suggested changes

  • Route the live-update edge through the API/router to the UI and label it as the WebSocket tail of task_events; keep the DB as the persistence/write target.
  • Preserve the legacy fallback_model compatibility note when reconciling the fallback documentation (hermes_cli/fallback_config.py:51-64).

Automated hermes-sweeper review.

Comment thread website/docs/user-guide/features/kanban.md
@teknium1 teknium1 added sweeper:risk-compatibility Sweeper risk: may break existing users, config, migrations, defaults, or upgrades sweeper:blast-moderate Sweeper blast radius: moderate — a subsystem or single platform labels Jul 13, 2026
@camaragon
camaragon force-pushed the auto/hermes-self-improvement branch from 9f6b584 to c3a6921 Compare August 7, 2026 22:42
@camaragon

Copy link
Copy Markdown
Contributor Author

Refreshed onto current main and addressed all review threads in c3a6921c8d.

Current scope:

  • replace two remaining ASCII diagrams with Mermaid
  • model Kanban live updates accurately through FastAPI/WebSocket tailing persisted task_events
  • document no fallback environment variables and preserve the legacy fallback_model compatibility note
  • drop stale/out-of-scope edits already superseded on current main

Verification:

  • full Docusaurus build: passed for English and zh-Hans
  • full ASCII guard: passed
  • touched-file ASCII guard: passed
  • git diff --check: passed

@camaragon camaragon changed the title docs: refresh fallback-provider and docs-lint examples docs: replace ASCII diagrams and clarify fallback config Aug 7, 2026
@camaragon
camaragon force-pushed the auto/hermes-self-improvement branch from c3a6921 to 6ac541a Compare August 18, 2026 23:36
@camaragon

Copy link
Copy Markdown
Contributor Author

Refreshed onto current main at 6ac541a6db. Fresh local verification: full diagram lint passed; full Docusaurus build generated both locales successfully; no broken-link warning originated from the three touched source pages; git diff --check passed. The prior Kanban WebSocket-boundary review request remains addressed and no unresolved review threads remain. Fresh GitHub CI is running on the new head.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/config Config system, migrations, profiles comp/gateway Gateway runner, session dispatch, delivery P3 Low — cosmetic, nice to have sweeper:blast-moderate Sweeper blast radius: moderate — a subsystem or single platform sweeper:risk-compatibility Sweeper risk: may break existing users, config, migrations, defaults, or upgrades type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants