629aeeebea
Add a developer-guide page for running the Ink TUI and Electron desktop app from a git worktree without a full npm install per checkout, via the htui/hgui shell helpers that share node_modules from a canonical deps checkout by symlink (falling back to a local npm ci when the lockfile diverges). Registers it in the sidebar, cross-links from the TUI and git -worktrees pages, and documents the previously-undocumented HERMES_DESKTOP_PYTHON / HERMES_DESKTOP_DEV_SERVER env vars the desktop backend reads.
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.