mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-24 16:54:43 +00:00
Audited every reference against ground truth (COMMAND_REGISTRY, argparse --help output, TOOLSETS dict, provider profiles, DEFAULT_CONFIG) and corrected drift the restructure had carried over verbatim: - slash-commands.md: rebuilt from the live registry. Removes the phantom /skill command (never existed — skills load via /skills, hermes -s, or a skill's own /<name> command) and the wrong /q alias on /quit (/q belongs to /queue) — both reported by @liuhao1024 in #50608 and @gauravsaxena1997 in #50613. Adds ~25 real commands that were missing (/learn, /memory, /pet, /hatch, /bundles, /moa, /suggestions, /blueprint, /whoami, …) with correct aliases and CLI/GW scoping. - cli-reference.md: verified flags (-z/--oneshot, --tui/--cli, --safe-mode), real subcommand sets for config/setup/sessions/skills/gateway/mcp/profile/ auth/webhook/cron/skin/pets, added missing top-level commands (fallback, project, moa, logs, console, hooks, security, backup); condensed tables. - providers-and-models.md: rebuilt from the 36 shipped provider profiles with their actual env vars (was 21 rows, several stale); folds in the alias system and fallback-chain command. - configuration.md: toolset table matches TOOLSETS (adds coding, computer_use, video_gen, context_engine, project; drops nonexistent messaging/rl), config sections match DEFAULT_CONFIG, STT/TTS provider lists match the shipped set. - background-systems.md: curator verbs match the argparse surface. - troubleshooting/security-privacy/windows-quirks/contributor-guide: fixed dangling 'section above/below' references from the body split; moved the reset-permissions playbook to security-privacy.md (its routing home). Reported-by: liuhao1024 <sunsky.lau@gmail.com> Reported-by: gauravsaxena1997 |
||
|---|---|---|
| .. | ||
| docs | ||
| i18n/zh-Hans/docusaurus-plugin-content-docs/current | ||
| scripts | ||
| src | ||
| static | ||
| .gitignore | ||
| docusaurus.config.ts | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.ts | ||
| tsconfig.json | ||
Website
This website is built using Docusaurus, a modern static website generator.
Installation
yarn
Local Development
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
USE_SSH=true yarn deploy
Not using SSH:
GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Diagram Linting
CI runs ascii-guard to lint docs for ASCII box diagrams. Use Mermaid (````mermaid`) or plain lists/tables instead of ASCII boxes to avoid CI failures.