# Getting Started

The HOLI docs site is an isolated [Vocs](https://vocs.dev) project inside the
`docs-site/` directory of the `holi-frontend` repository. It is kept separate from
the main poster app so the two deploy independently.

## Run locally

```bash
cd docs-site
npm install
npm run dev
```

The dev server starts on [http://localhost:5174](http://localhost:5174).

## Build

```bash
cd docs-site
npm run build     # outputs to docs-site/dist
npm run preview   # serve the production build locally
```

## Project structure

```
docs-site/
├── src/
│   └── pages/          # Markdown / MDX pages (routes)
│       ├── index.mdx
│       └── getting-started.mdx
├── public/             # static assets (served at the site root)
├── vocs.config.ts      # site config: title, nav, sidebar, theme
├── package.json
└── tsconfig.json
```

## Deployment

The site is configured to be served at [docs.holi.capital](https://docs.holi.capital)
via the `baseUrl` in `vocs.config.ts`. This value drives the canonical URLs in
`sitemap.xml`, `robots.txt`, and `llms.txt`.

Vocs auto-detects Vercel (via the `VERCEL` environment variable) and applies a
Vercel-optimized adapter at build time, so no extra config file is required. To
deploy on Vercel:

1. Create a Vercel project from this repository and set the **Root Directory** to
   `docs-site` (the docs live in a subdirectory, separate from the main app).
2. Keep the auto-filled framework settings — Build Command `npm run build`,
   Output Directory `dist`, Install Command `npm install`.
3. Add the custom domain `docs.holi.capital` to the project under
   **Settings → Domains**, and point the `docs` CNAME at Vercel in your DNS.

Pushing to the default branch deploys to production; other branches and PRs get
preview URLs.