mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
609579abab
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Runs E2E Fallback Tests / E2E Fallback Tests (Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Lint & build / lint_and_build (24) (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
# docs-mintlify
|
|
|
|
How to run the Mintlify docs preview locally from this repository.
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js `>=20.17.0`
|
|
- `pnpm`
|
|
- Repository dependencies installed (`pnpm install` from repo root)
|
|
- OpenAPI specs in `openapi/` are **committed to git**. Hosted Mintlify cannot run monorepo codegen on deploy, so these files must be present in the repo for production docs.
|
|
|
|
When you change API route OpenAPI metadata, regenerate and **commit** the four specs from the repo root:
|
|
|
|
```bash
|
|
pnpm run --filter @hexclave/backend codegen-docs
|
|
git add docs-mintlify/openapi/
|
|
```
|
|
|
|
That writes `client.json`, `server.json`, `admin.json`, and `webhooks.json` into `docs-mintlify/openapi/` (and into `docs/openapi/` for the legacy Fumadocs app). CI fails if `pnpm codegen` produces different output than what is committed (see root lint-and-build workflow).
|
|
|
|
## Run locally
|
|
|
|
From the repository root:
|
|
|
|
```bash
|
|
pnpm -C docs-mintlify run dev
|
|
```
|
|
|
|
This starts Mintlify in `docs-mintlify` on `http://localhost:${NEXT_PUBLIC_HEXCLAVE_PORT_PREFIX:-81}04` (for example, `http://localhost:8104` with the default prefix).
|
|
|
|
From inside `docs-mintlify`, you can also run:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Useful variants:
|
|
|
|
```bash
|
|
# Override the default port
|
|
pnpm -C docs-mintlify run dev -- --port 3333
|
|
|
|
# Skip OpenAPI processing for faster iteration
|
|
pnpm -C docs-mintlify run dev -- --disable-openapi
|
|
```
|
|
|
|
## Search + assistant in local preview
|
|
|
|
If you want local search and the Mintlify assistant:
|
|
|
|
```bash
|
|
pnpm -C docs-mintlify run login
|
|
pnpm -C docs-mintlify run status
|
|
```
|
|
|
|
Then re-run `pnpm -C docs-mintlify run dev`.
|
|
|
|
## Package scripts
|
|
|
|
From repo root:
|
|
|
|
```bash
|
|
pnpm -C docs-mintlify run lint
|
|
pnpm -C docs-mintlify run typecheck
|
|
pnpm -C docs-mintlify run build
|
|
pnpm -C docs-mintlify run clean
|
|
```
|
|
|
|
`lint` runs both `mint validate` and `mint broken-links`.
|