hermes-admin/hermes-agent
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity
Files
6c02e39a5a32f8d4ab5214845220a592d9766a36
hermes-agent/website/README.md
teknium1 6c02e39a5a docs(website): tell GitHub readers the docs are authored for the rendered site; record the link convention 
Cross-page links under website/docs are Docusaurus doc-root routes
(1,338 across 250 EN files, 898 in the zh-Hans mirror) and 404 in GitHub's
file viewer, which resolves them as repository paths. Converting the tree
(~2,200 links, anchors in cross-section links, two locales) is a maintainer
call; until then the README at the top of website/ says where the rendered
docs live and how links are written, so new pages stay consistent with
their neighbours.
2026-09-18 14:27:04 -07:00

1.8 KiB
Raw Blame History

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/. Most cross-page links are Docusaurus site routes (/getting-started/installation), which GitHub's file viewer resolves as repository paths and 404s. Every page has an Edit this page link on the site that opens the source file here.

Authoring links in docs/

  • Link to another page with a doc-root route ([Profiles](/user-guide/profiles)) or a relative Markdown path ([Profiles](../user-guide/profiles.md)). Both render on the site; only the relative form also resolves on GitHub.
  • Never write /docs/... in a link: baseUrl is already /docs/, so the zh-Hans build emits /docs/zh-Hans/docs/... 404s.
  • Cross-section links with an anchor use the route form (/section/page#anchor); pin {#anchor} on the target heading 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.