Files
hermes-agent/website
Yuan Li e40637dcba test(install): drive -SkipSetup alone through the needs-input stage frame; sync zh-Hans doc
Address review on #125371: the binding test passed the script-level
-NonInteractive alongside the alias, so deleting the fold line kept it
green. The new test runs -Stage setup -Json with only -SkipSetup and
asserts the skipped/needs-user-input frame, which only the fold can
produce (without it the stage dispatches interactively and fails under
a non-interactive host). Also document the deprecated alias in the
zh-Hans windows-native guide, which still said -SkipSetup is rejected.

(cherry picked from commit b97fc4561af918910b8b2b9bf728e501b89aeb27)
2026-09-28 00:58:16 +05:30
..
…
…

Website

This website is built using Docusaurus, a modern static website generator.

Reading the docs on GitHub? The Markdown under docs/ is authored for the rendered site at https://hermes-agent.nousresearch.com/docs/. Cross-page links are relative Markdown paths, so they follow through on GitHub's file viewer too. Every page on the site has an Edit this page link that opens the source file here.

  • Link to another page with a relative Markdown path, anchors included: [Profiles](../user-guide/profiles.md), [Bundles](../user-guide/features/skills.md#skill-bundles). Docusaurus turns the file path into the page route; GitHub follows the same path. Site routes (/user-guide/profiles, /docs/user-guide/profiles) only work on the rendered site — GitHub resolves them as repository paths and 404s, and the /docs/ form also emits /docs/zh-Hans/docs/... 404s in the zh-Hans build because baseUrl is already /docs/.
  • python3 website/scripts/check_doc_links.py fails on any route-style link in hand-authored pages (EN and the zh-Hans mirror); --fix rewrites them. It runs in the Docs Site Checks workflow. Generated pages (user-guide/skills/{bundled,optional}, reference/*skills-catalog.md) are produced by scripts/generate-skill-docs.py, which emits the same relative form.
  • Pin {#anchor} on cross-linked headings so the zh-Hans mirror keeps the same id.

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.