Stack Auth provides a comprehensive suite of documentation and example applications to facilitate rapid integration and deep technical understanding of the platform. The documentation strategy is split between a user-focused guide site (Mintlify), a developer-centric reference site (Fumadocs), and a collection of functional example repositories.
The project maintains two primary documentation sites, each serving a distinct purpose in the developer lifecycle.
The Mintlify site, located in docs-mintlify/, serves as the primary entry point for new users. It focuses on conceptual overviews, step-by-step guides, and high-level SDK references docs-mintlify/docs.json43-145 It is configured via a docs.json file that defines navigation tabs for "Documentation", "SDK Reference", and "REST API" docs-mintlify/docs.json147-179 The homepage uses custom components like HomePromptIsland and DocsAppsHomeGrid to provide a dashboard-like navigation experience docs-mintlify/index.mdx7-18
The Fumadocs-based site in docs/ provides a more interactive, technical experience. It includes:
AIChat component docs/src/components/chat/ai-chat.tsx1-40 that uses the Model Context Protocol (MCP) and useChat from @ai-sdk/react to search documentation and answer technical queries docs/src/components/chat/ai-chat.tsx3-6 It includes a SearchDocsDisplay to render search results with scores and URLs docs/src/components/chat/ai-chat.tsx42-80client.json, server.json, admin.json, webhooks.json) docs-mintlify/README.md12-19 These pages feature an EnhancedAPIPage component docs/src/components/api/enhanced-api-page.tsx49-70 allowing developers to test requests directly from the browser using a built-in playground.AuthPanel docs/src/components/api/auth-panel.tsx44-58 that integrates with the user's active session via useOwnedProjects docs/src/components/api/auth-panel.tsx53-56 to automatically populate API keys and tokens (e.g., X-Stack-Admin-Access-Token) for live testing against their own projects docs/src/components/api/auth-panel.tsx90-107For details, see Documentation Sites (Fumadocs & Mintlify).
Stack Auth includes a variety of example applications in the examples/ directory to demonstrate integration patterns across different stacks:
For details, see Example Applications.
The following diagrams illustrate how documentation entities relate to the underlying code and external services.
This diagram bridges the "Natural Language Space" of user queries to the "Code Entity Space" of the documentation generators and search handlers.
Sources: docs-mintlify/README.md12-19 docs/src/components/chat/ai-chat.tsx149-153 docs/src/components/layout/custom-search-dialog.tsx224-236
This diagram shows how the EnhancedAPIPage interacts with the AuthPanel and the backend SmartRouteHandler.
Sources: docs/src/components/api/enhanced-api-page.tsx49-70 docs/src/components/api/auth-panel.tsx29-36 docs/src/components/api/auth-panel.tsx101-105
| Resource | Path | Technology | Primary Purpose |
|---|---|---|---|
| User Guides | docs-mintlify/ | Mintlify | Onboarding, Tutorials, Feature Overviews |
| API Reference | docs/ | Fumadocs | Interactive API testing, OpenAPI browsing |
| AI Assistant | docs/src/components/chat/ | AI SDK / Vercel | Natural language querying of docs |
| OpenAPI Specs | docs-mintlify/openapi/ | JSON / Swagger | Source of truth for API structure |
| Search Engine | docs/src/app/api/search/ | Next.js Route | Vector/Keyword search across all docs |
Sources: docs-mintlify/docs.json1-10 docs/src/components/chat/ai-chat.tsx3-10 docs-mintlify/README.md12-19 docs/src/components/layout/custom-search-dialog.tsx224-236