c59643855d
Three small fixes from the parallel reviewers on PR 3:
1. **tanstack-start-demo vite SSR regex** — examples/tanstack-start-demo/
vite.config.ts:76 had `noExternal: [/^@stackframe\//, ...]`. The
regex was missed by the source rename sweep because it's a regex
pattern, not a string literal. After the rename no @stackframe/*
package exists in the workspace, so the regex matched nothing and
workspace deps (`@hexclave/tanstack-start`, `@hexclave/shared`,
`@hexclave/ui`) stopped being inlined for SSR. Without inlining,
the Nitro server hits ERR_REQUIRE_ESM on first request because the
CJS bundles import ESM-only transitive deps (jose, oauth4webapi).
Flipped to /^@hexclave\// to match the renamed packages.
2. **docs.json footer GitHub link** — pointed at hexclave/stack (404,
no such repo). The navbar at line 34 already uses hexclave/hexclave
per the plan, so aligned the footer to match.
3. **README cleanups**:
- Alt text 'Stack Logo' → 'Hexclave Logo' on the header image.
- Removed broken /docs/next prefix on the setup-guide link (the
actual docs structure is /getting-started/setup, no /docs/next).
- contrib.rocks image now points at hexclave/hexclave (was the old
stack-auth/stack URL).
What I did NOT touch (out of PR 3 scope, surfaced separately for a
follow-up doc-pedagogy PR):
- 14+ docs-mintlify pages teaching STACK_* env vars instead of
HEXCLAVE_* (works via dual-read, but contradicts migration.mdx's
'new code should use HEXCLAVE_*' recommendation).
- REST API code samples teaching X-Stack-* headers instead of
X-Hexclave-* (works via dual-accept proxy).
- docs-mintlify/sdk/objects/stack-app.mdx broken in-page anchors
(#stackclientapp etc. — body headings renamed in PR 2 but
anchor IDs weren't updated).
- MCP server name inconsistency (`stack-auth` in init-prompt.ts vs
`hexclave` in dashboard setup-page).
- The `ask_stack_auth` MCP tool was removed despite
RENAME-TO-HEXCLAVE.md saying it should stay registered as a
compat alias indefinitely.
- AI prompts (apps/backend/src/lib/ai/prompts.ts, apps/skills/) still
teach legacy header / env-var names in generated code examples.
All of those are PR 2 pedagogy carry-over, not introduced by this PR,
and work functionally via the dual-read/dual-accept compat layers PR
1 + PR 2 put in place. They're documentation polish, not bugs that
block PR 3 shipping.
|
||
|---|---|---|
| .. | ||
| api | ||
| guides | ||
| images | ||
| openapi | ||
| sdk | ||
| snippets | ||
| .gitignore | ||
| apps-sidebar-filter.js | ||
| code-language-labels.js | ||
| docs.json | ||
| index.mdx | ||
| migration.mdx | ||
| package.json | ||
| README.md | ||
| style.css | ||
docs-mintlify
How to run the Mintlify docs preview locally from this repository.
Prerequisites
-
Node.js
>=20.17.0 -
pnpm -
Repository dependencies installed (
pnpm installfrom 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 @hexclave/backend codegen-docs git add docs-mintlify/openapi/That writes
client.json,server.json,admin.json, andwebhooks.jsonintodocs-mintlify/openapi/(and intodocs/openapi/for the legacy Fumadocs app). CI fails ifpnpm codegenproduces 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.