mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
7125a9eff4
Source rename across the monorepo. Every publishable package now ships
under its @hexclave/* name natively, no rewrite-at-publish indirection.
Workflow + tooling:
- Delete scripts/rewrite-packages-to-hexclave.ts (one-shot mirror).
- Remove the mirror-publish block from .github/workflows/npm-publish.yaml.
The remaining `pnpm publish -r` step publishes @hexclave/* natively.
- Flip the auto-bump changeset target from @stackframe/stack to
@hexclave/next so 'Update package versions on dev' keeps working.
- Delete packages/template/src/internal/deprecation-warning.ts and its
imports — @hexclave/* never warns about itself, and after PR 3 no
@stackframe/* artifact is ever built from source again.
Package renames (publishable):
@stackframe/react → @hexclave/react
@stackframe/stack → @hexclave/next
@stackframe/js → @hexclave/js
@stackframe/stack-shared → @hexclave/shared
@stackframe/stack-ui → @hexclave/ui
@stackframe/stack-sc → @hexclave/sc
@stackframe/stack-cli → @hexclave/cli
@stackframe/tanstack-start → @hexclave/tanstack-start
@stackframe/dashboard-ui-components → @hexclave/dashboard-ui-components
Internal monorepo packages (private, never published) also renamed for
brand consistency: backend, dashboard, docs, mcp, skills, e2e-tests,
example apps, the swift-sdk, the monorepo root, etc. Cost is mechanical;
payoff is no stray @stackframe/* names left under apps/, examples/, sdks/.
Carve-outs intentionally kept under their legacy names:
- @stackframe/emails — virtual module imported by customer-stored email
templates; the renderer in apps/backend/src/lib/email-rendering.tsx
dual-aliases both names to the same backing module indefinitely.
- @stackframe/template — internal codegen source, never published; per
docs-mintlify/migration.mdx 'internal packages keep names'.
- @stackframe/init-stack — deprecated; now marked private: true so the
last published version on npm continues to serve old install commands
but the workspace stops publishing it.
Backward-compat detection (so projects still on the last @stackframe/*
release keep working):
- packages/stack-shared/src/config-rendering.ts — CONFIG_IMPORT_PACKAGES
table includes both @hexclave/* (canonical, first match wins) and
legacy @stackframe/* names. Function renamed
detectStackframeImportPackage → detectConfigImportPackage.
- apps/dashboard/src/lib/github-config-push.ts — import detection regex
now matches both @hexclave/<name> and @stackframe/<name>, hexclave
preferred.
Versions: every renamed package reset to 1.0.0 in source. The repo's
existing 'bump versions before merging to main' flow will move them to
1.0.1 on the first publish run, so the dual-publish 1.0.0 from PR 2 is
not overwritten.
Other touch-ups discovered during sweep:
- Root package.json: 'fern' script filter was @stackframe/docs (legacy
typo, never resolved) → @hexclave/docs.
- README.md contributor note: @stackframe/XYZ → @hexclave/XYZ.
- packages/stack-cli/package.json: register `hexclave` bin alongside
the legacy `stack` bin so `npx @hexclave/cli init` works on the
natively-published artifact (PR 1481's rewrite script did this at
publish time; now it's in source).
- packages/template/package-template.json: per-platform names + version
flipped to hexclave + 1.0.0 to stay in sync with generated package.json.
- docs/package.json (legacy fumadocs folder, otherwise carved out of the
brand sweep): workspace deps and name updated minimally so `pnpm
install` resolves — content (MDX) intentionally untouched per the
PR 2 scoping decision.
Carve-out files (skipped entirely by the sweep, intentional history):
- docs-mintlify/migration.mdx — teaches the rename, references both.
- RENAME-TO-HEXCLAVE.md — planning doc, references both indefinitely.
- legacy docs/ folder — content untouched per PR 2 carve-out.
generate-sdks regenerated packages/{react,stack,js} from template.
pnpm-lock.yaml regenerated. Typecheck green on stack-shared, stack, js,
react. Dashboard typecheck has pre-existing 'X is of type unknown'
errors that need to be investigated separately (likely a local
node_modules build state issue, not source).
|
||
|---|---|---|
| .. | ||
| code-examples | ||
| content/docs | ||
| lib | ||
| public | ||
| scripts | ||
| src | ||
| templates-api | ||
| .env | ||
| .env.development | ||
| .eslintrc.json | ||
| .gitignore | ||
| cli.json | ||
| instrumentation-client.ts | ||
| next.config.mjs | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| source.config.ts | ||
| tsconfig.json | ||
Stack Auth Documentation
This is the documentation site for Stack Auth, built with Next.js and Fumadocs.
Development
pnpm dev
The docs server runs on port 8104 by default (or ${NEXT_PUBLIC_STACK_PORT_PREFIX}04).
Project Structure
Content (/content)
| Directory | Description |
|---|---|
content/docs/ |
Main documentation (guides, SDK reference, components) |
content/api/ |
REST API reference documentation |
App Routes (/src/app)
| Route | Description |
|---|---|
/docs |
Main documentation pages |
/api |
API reference pages (rendered from OpenAPI specs) |
/docs-embed |
Embedded docs for dashboard companion widget |
/api-embed |
Embedded API docs for dashboard companion widget |
/mcp-browser |
MCP documentation browser |
/handler/[...stack] |
Stack Auth handler route |
/api/search |
Search API endpoint |
/api/chat |
AI documentation chat endpoint |
/llms.txt |
LLM-friendly documentation (plain text) |
/llms.mdx |
LLM-friendly documentation (MDX format) |
SDK Route Handlers
These routes serve SDK-specific documentation:
/js/[...path]- JavaScript SDK/next/[...path]- Next.js SDK/react/[...path]- React SDK/python/[...path]- Python SDK/rest-api/[...path]- REST API
Key Files
| File | Description |
|---|---|
lib/source.ts |
Content source adapter using Fumadocs loader() |
source.config.ts |
Fumadocs MDX configuration (frontmatter schema, etc.) |
app/layout.config.tsx |
Shared layout options |
lib/platform-config.ts |
Platform/framework configuration for code examples |
Components (/src/components)
| Directory | Description |
|---|---|
api/ |
API playground components |
chat/ |
AI chat interface |
layout/ |
Layout UI components (search, navigation) |
layouts/ |
Page layouts (docs, API) |
mdx/ |
Custom MDX components |
stack-auth/ |
Stack Auth demo components |
ui/ |
Base UI components (button, etc.) |
OpenAPI Specs (/openapi)
Contains OpenAPI JSON specifications organized by access level:
client-*.json- Client-side API endpointsserver-*.json- Server-side API endpointsadmin-*.json- Admin API endpointswebhooks-*.json- Webhook event schemas
Scripts
# Generate API docs from OpenAPI specs
pnpm generate-openapi-docs
# Clear generated docs
pnpm clear-docs