CodeCow/stack
1
0
Fork 0
mirror of https://github.com/stack-auth/stack.git synced 2026-06-04 21:04:37 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
feat/migrations
stack/docs-mintlify
History
mantrakp04 7bcc28df78 Add AuthDataMigrationJob model and related migration scripts 
- Introduced the AuthDataMigrationJob model in the Prisma schema to manage authentication migration jobs.
- Created SQL migration scripts to establish the AuthDataMigrationJob table with necessary constraints and indexes.
- Implemented API routes for creating, listing, retrieving, and retrying auth migration jobs.
- Added utility functions for handling encryption and decryption of migration credentials.
- Developed tests to validate the functionality and constraints of the new migration job model.
2026-05-04 09:41:00 -07:00
..
api docs(mintlify): generate REST API from OpenAPI specs. Wire docs.json to Mintlfiy OpenAPI, keeping api/overview. Remove hand-written endpoint MDX; ignore generated openapi/ and export zips. Add ensure-openapi check before mint validate; document codegen in readme 2026-04-08 17:12:27 -05:00
guides Add AuthDataMigrationJob model and related migration scripts 2026-05-04 09:41:00 -07:00
images App icons in Mintlify docs sidebar 2026-04-06 19:23:10 -07:00
sdk Temporarily remove mint broken-links 2026-04-08 16:59:55 -07:00
snippets Docs overview update 2026-04-13 15:30:13 -07:00
.gitignore Don't commit openapi schemas 2026-04-09 13:01:59 -07:00
docs.json Add Better Auth to Stack Auth migration package 2026-05-01 15:42:59 -07:00
index.mdx Docs overview update 2026-04-13 15:30:13 -07:00
package.json chore: update package versions 2026-04-20 19:06:56 -07:00
README.md update package.json to remove ensure-openapi 2026-04-08 19:12:30 -05:00
style.css docs-mintlify: Fix app icon styling 2026-04-13 11:28:12 -07:00

README.md

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:

    pnpm run --filter @stackframe/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:

pnpm -C docs-mintlify run dev

This starts Mintlify in docs-mintlify on http://localhost:${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}04 (for example, http://localhost:8104 with the default prefix).

From inside docs-mintlify, you can also run:

pnpm dev

Useful variants:

# 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:

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:

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.