This directory contains the VitePress documentation site for introducing LoopAI.

1. Check Node.js version

node -v

It is recommended to use Node.js 20.x.

2. Check Yarn

yarn -v

If Yarn is not installed yet, you can enable it with Corepack:

corepack enable
corepack prepare yarn@stable --activate
yarn -v

Install dependencies:

yarn install

Start the VitePress docs site locally:

yarn docs:dev

Default local address:

http://localhost:5174

Build the static site:

yarn docs:build

Preview the built site locally:

yarn docs:preview

Default preview address:

http://localhost:4174

tutorial/
├── docs/
│   ├── .vitepress/     # VitePress site config
│   ├── guide/          # Tutorial pages
│   ├── public/         # Static assets such as images
│   └── index.md        # Home page
├── package.json
└── README.md

• docs/index.md: LoopAI overview
• docs/guide/webui-tutorial.md: WebUI tutorial
• docs/guide/cli-tutorial.md: CLI tutorial
• docs/guide/details/: Per-agent detailed guides

• Put screenshots and static images under docs/public/
• WebUI tutorial images are currently stored under docs/public/images/webui/