website/README.md

# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
yarn
```

## Local Development

```bash
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

```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
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.
feat: add documentation website (Docusaurus) - 25 documentation pages covering Getting Started, User Guide, Developer Guide, and Reference - Docusaurus with custom amber/gold theme matching the landing page branding - GitHub Actions workflow to deploy landing page + docs to GitHub Pages - Landing page at root, docs at /docs/ on hermes-agent.nousresearch.com - Content extracted and restructured from existing repo docs (README, AGENTS.md, CONTRIBUTING.md, docs/) - Auto-deploy on push to main when website/ or landingpage/ changes 2026-03-05 05:24:55 -08:00			`# Website`

			`This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.`

			`## Installation`

			```bash
			`yarn`
			```

			`## Local Development`

			```bash
			`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`

			```bash
			`yarn build`
			```

			This command generates static content into the `build` directory and can be served using any static contents hosting service.

			`## Deployment`

			`Using SSH:`

			```bash
			`USE_SSH=true yarn deploy`
			```

			`Not using SSH:`

			```bash
			`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.
docs: replace ASCII diagrams with Mermaid/lists, add linting note CI enforces ascii-guard linting on docs. Replaced ASCII box diagrams with Mermaid flowcharts (open-webui architecture) and numbered lists (CLI layout). Added diagram linting note to website README. Based on PR #2364 by aydnOktay (closed — README had broken formatting). 2026-03-21 17:58:30 -07:00
			`## 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.