03fae2fac8
cff26600d2 stopped following symlinks when carrying untracked/ignored files into a staged catalog update: a link planted after the installer's scan could point outside the plugin root, past the guard. But it did so by skipping them silently. Base followed the link and kept the content, so a user whose ignored config.yaml is a link into their dotfiles now loses that config on repin with no warning. _carry_user_files promises to fail before publication rather than drop user state. In a git checkout, symlinked files or dirs in the ??/!! set now fail the update before publication, and the error names every such path. Links are still never followed. Links under node_modules/ are .bin shims that a reinstall recreates, so they stay skipped rather than blocking every JS plugin's update. The no-git branch is unchanged: there, links may be upstream's own. The existing ignored-data-dir git test gains the case: the update refuses, names data/link.yaml, and the live plugin keeps its revision, its link and its data. This also gives the no-follow rule a test that fails if the link is followed.
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.
Authoring links in docs/
- 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 becausebaseUrlis already/docs/. python3 website/scripts/check_doc_links.pyfails on any route-style link in hand-authored pages (EN and the zh-Hans mirror);--fixrewrites them. It runs in theDocs Site Checksworkflow. Generated pages (user-guide/skills/{bundled,optional},reference/*skills-catalog.md) are produced byscripts/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.