History

Teknium 9467e99ac5 docs(site): redirect /quickstart and /installation short paths Users following abbreviated links guess /docs/quickstart and /docs/installation and hit raw GitHub-Pages 404s — the real pages live under /docs/getting-started/. Add client redirects for both. Consumer-onboarding audit finding #1, Aug 2026.		2026-08-01 15:34:27 -07:00
..
docs	feat(desktop): add terminal font picker	2026-08-01 14:30:08 -07:00
i18n/zh-Hans/docusaurus-plugin-content-docs/current	fix(deps): repair Google transitive security floors (#72108 )	2026-07-31 23:18:38 -07:00
scripts	…
src	…
static	…
.gitignore	…
.npmrc	…
README.md	…
docusaurus.config.ts	docs(site): redirect /quickstart and /installation short paths	2026-08-01 15:34:27 -07:00
package-lock.json	…
package.json	…
sidebars.ts	…
tsconfig.json	…

README.md

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.