mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
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.
281 lines
8.3 KiB
JSON
281 lines
8.3 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"name": "Hexclave Documentation",
|
|
"theme": "mint",
|
|
"logo": {
|
|
"dark": "/images/logo-dark.svg",
|
|
"light": "/images/logo-light.svg"
|
|
},
|
|
"favicon": "/images/favicon.ico",
|
|
"colors": {
|
|
"primary": "#6b5df7",
|
|
"light": "#8b7cf9",
|
|
"dark": "#6b5df7"
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"dark": "#09090b"
|
|
}
|
|
},
|
|
"fonts": {
|
|
"heading": {
|
|
"family": "Geist",
|
|
"weight": 500
|
|
},
|
|
"body": {
|
|
"family": "Geist",
|
|
"weight": 400
|
|
}
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"type": "github",
|
|
"href": "https://github.com/hexclave/hexclave"
|
|
}
|
|
],
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Dashboard",
|
|
"href": "https://app.hexclave.com"
|
|
}
|
|
},
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"pages": [
|
|
"index",
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"guides/getting-started/setup",
|
|
"guides/getting-started/user-fundamentals",
|
|
"guides/getting-started/ai-integration"
|
|
]
|
|
},
|
|
{
|
|
"group": "Going Further",
|
|
"pages": [
|
|
"guides/going-further/stack-app",
|
|
"guides/going-further/backend-integration",
|
|
"guides/going-further/cli",
|
|
"guides/going-further/local-emulator",
|
|
"guides/going-further/local-development",
|
|
"guides/going-further/user-metadata"
|
|
]
|
|
},
|
|
{
|
|
"group": "Apps",
|
|
"pages": [
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "/images/app-icons/authentication.svg",
|
|
"pages": [
|
|
"guides/apps/authentication/overview",
|
|
"guides/apps/authentication/user-onboarding",
|
|
"guides/apps/authentication/restricted-users",
|
|
"guides/apps/authentication/connected-accounts",
|
|
"guides/apps/authentication/jwts",
|
|
"guides/apps/authentication/sign-up-rules",
|
|
"guides/apps/authentication/cli-authentication",
|
|
{
|
|
"group": "All Auth Providers",
|
|
"root": "guides/apps/authentication/auth-providers",
|
|
"pages": [
|
|
"guides/apps/authentication/auth-providers/apple",
|
|
"guides/apps/authentication/auth-providers/bitbucket",
|
|
"guides/apps/authentication/auth-providers/discord",
|
|
"guides/apps/authentication/auth-providers/facebook",
|
|
"guides/apps/authentication/auth-providers/github",
|
|
"guides/apps/authentication/auth-providers/gitlab",
|
|
"guides/apps/authentication/auth-providers/google",
|
|
"guides/apps/authentication/auth-providers/linkedin",
|
|
"guides/apps/authentication/auth-providers/microsoft",
|
|
"guides/apps/authentication/auth-providers/passkey",
|
|
"guides/apps/authentication/auth-providers/spotify",
|
|
"guides/apps/authentication/auth-providers/twitch",
|
|
"guides/apps/authentication/auth-providers/two-factor-auth",
|
|
"guides/apps/authentication/auth-providers/x-twitter"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"guides/apps/emails/overview",
|
|
"guides/apps/payments/overview",
|
|
"guides/apps/analytics/overview",
|
|
{
|
|
"group": "Teams",
|
|
"icon": "/images/app-icons/teams.svg",
|
|
"pages": [
|
|
"guides/apps/teams/overview",
|
|
"guides/apps/teams/team-selection"
|
|
]
|
|
},
|
|
"guides/apps/fraud-protection/overview",
|
|
"guides/apps/rbac/overview",
|
|
"guides/apps/api-keys/overview",
|
|
"guides/apps/data-vault/overview",
|
|
"guides/apps/webhooks/overview",
|
|
"guides/apps/launch-checklist/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
"guides/integrations/tanstack-start/overview",
|
|
"guides/integrations/supabase/overview",
|
|
"guides/integrations/convex/overview",
|
|
"guides/integrations/vercel/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "Other",
|
|
"pages": [
|
|
"guides/other/self-host",
|
|
"guides/other/known-errors",
|
|
"migration",
|
|
{
|
|
"group": "Tutorials",
|
|
"pages": [
|
|
"guides/other/tutorials/build-a-saas-with-stack-auth",
|
|
"guides/other/tutorials/build-a-team-based-app",
|
|
"guides/other/tutorials/ship-production-ready-auth"
|
|
]
|
|
},
|
|
"guides/other/showcase"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "SDK Reference",
|
|
"pages": [
|
|
"sdk/overview",
|
|
{
|
|
"group": "Objects",
|
|
"pages": ["sdk/objects/stack-app"]
|
|
},
|
|
{
|
|
"group": "Types",
|
|
"pages": [
|
|
"sdk/types/user",
|
|
"sdk/types/team",
|
|
"sdk/types/team-user",
|
|
"sdk/types/team-permission",
|
|
"sdk/types/team-profile",
|
|
"sdk/types/contact-channel",
|
|
"sdk/types/email",
|
|
"sdk/types/api-key",
|
|
"sdk/types/project",
|
|
"sdk/types/connected-account",
|
|
"sdk/types/item",
|
|
"sdk/types/customer"
|
|
]
|
|
},
|
|
{
|
|
"group": "Hooks",
|
|
"pages": ["sdk/hooks/use-stack-app", "sdk/hooks/use-user"]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "REST API",
|
|
"pages": [
|
|
"api/overview",
|
|
{
|
|
"group": "Client API",
|
|
"openapi": {
|
|
"source": "openapi/client.json",
|
|
"directory": "api/client"
|
|
}
|
|
},
|
|
{
|
|
"group": "Server API",
|
|
"openapi": {
|
|
"source": "openapi/server.json",
|
|
"directory": "api/server"
|
|
}
|
|
},
|
|
{
|
|
"group": "Admin API",
|
|
"openapi": {
|
|
"source": "openapi/admin.json",
|
|
"directory": "api/admin",
|
|
"hidden": "true"
|
|
}
|
|
},
|
|
{
|
|
"group": "Webhooks",
|
|
"openapi": {
|
|
"source": "openapi/webhooks.json",
|
|
"directory": "api/webhooks"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://x.com/stack_auth",
|
|
"github": "https://github.com/hexclave/hexclave",
|
|
"discord": "https://discord.hexclave.com"
|
|
}
|
|
},
|
|
"seo": {
|
|
"metatags": {
|
|
"robots": "noindex"
|
|
}
|
|
},
|
|
"settings": {
|
|
"customScripts": ["/apps-sidebar-filter.js", "/code-language-labels.js"]
|
|
},
|
|
"redirects": [
|
|
{
|
|
"source": "/rest-api/overview",
|
|
"destination": "/api/overview"
|
|
},
|
|
{
|
|
"source": "/getting-started/setup",
|
|
"destination": "/guides/getting-started/setup"
|
|
},
|
|
{
|
|
"source": "/docs/getting-started/setup",
|
|
"destination": "/guides/getting-started/setup"
|
|
},
|
|
{
|
|
"source": "/docs/next/getting-started/setup",
|
|
"destination": "/guides/getting-started/setup"
|
|
},
|
|
{
|
|
"source": "/docs/sdk",
|
|
"destination": "/sdk/overview"
|
|
},
|
|
{
|
|
"source": "/docs/apps/analytics",
|
|
"destination": "/guides/apps/analytics/overview"
|
|
},
|
|
{
|
|
"source": "/docs/apps/api-keys",
|
|
"destination": "/guides/apps/api-keys/overview"
|
|
},
|
|
{
|
|
"source": "/docs/others/convex",
|
|
"destination": "/guides/integrations/convex/overview"
|
|
},
|
|
{
|
|
"source": "/docs/concepts/teams",
|
|
"destination": "/guides/apps/teams/overview"
|
|
},
|
|
{
|
|
"source": "/docs/concepts/custom-user-data",
|
|
"destination": "/guides/going-further/user-metadata"
|
|
},
|
|
{
|
|
"source": "/others/js-client",
|
|
"destination": "/guides/going-further/stack-app"
|
|
}
|
|
]
|
|
}
|