From d2f252d3fab74023e7c45b05e99fd8d021eb5bf5 Mon Sep 17 00:00:00 2001 From: Konstantin Wohlwend Date: Mon, 6 Apr 2026 14:48:26 -0700 Subject: [PATCH] Improve docs sidebar content --- docs-mintlify/docs.json | 70 ++++----- docs-mintlify/docs/apps/launch-checklist.mdx | 135 ++++++++++++++--- docs-mintlify/docs/apps/oauth.mdx | 1 + docs-mintlify/docs/apps/orgs-and-teams.mdx | 1 + docs-mintlify/docs/apps/permissions.mdx | 1 + .../auth-providers/two-factor-auth.mdx | 1 + .../docs/concepts/backend-integration.mdx | 1 + docs-mintlify/docs/concepts/emails.mdx | 1 + .../docs/concepts/orgs-and-teams.mdx | 1 + docs-mintlify/docs/concepts/stack-app.mdx | 1 + .../docs/concepts/team-selection.mdx | 1 + .../docs/concepts/user-onboarding.mdx | 1 + .../docs/customization/custom-pages.mdx | 1 + docs-mintlify/docs/faq.mdx | 1 - .../docs/getting-started/components.mdx | 1 - .../docs/getting-started/production.mdx | 137 ------------------ docs-mintlify/docs/getting-started/setup.mdx | 1 - docs-mintlify/docs/getting-started/users.mdx | 3 +- .../docs/getting-started/vite-example.mdx | 3 +- .../docs/going-further/working-with-ai.mdx | 1 + .../build-a-saas-with-stack-auth.mdx | 14 ++ .../tutorials/build-a-team-based-app.mdx | 12 ++ .../tutorials/ship-production-ready-auth.mdx | 12 ++ docs-mintlify/docs/others/vercel.mdx | 57 ++++++++ docs-mintlify/index.mdx | 1 + 25 files changed, 259 insertions(+), 200 deletions(-) delete mode 100644 docs-mintlify/docs/getting-started/production.mdx create mode 100644 docs-mintlify/docs/others/tutorials/build-a-saas-with-stack-auth.mdx create mode 100644 docs-mintlify/docs/others/tutorials/build-a-team-based-app.mdx create mode 100644 docs-mintlify/docs/others/tutorials/ship-production-ready-auth.mdx create mode 100644 docs-mintlify/docs/others/vercel.mdx diff --git a/docs-mintlify/docs.json b/docs-mintlify/docs.json index 18906abdc..acdb5854f 100644 --- a/docs-mintlify/docs.json +++ b/docs-mintlify/docs.json @@ -52,7 +52,6 @@ "pages": [ "docs/getting-started/setup", "docs/getting-started/users", - "docs/getting-started/components", "docs/getting-started/production", "docs/getting-started/vite-example" ] @@ -60,7 +59,6 @@ { "group": "Going Further", "pages": [ - "docs/going-further/working-with-ai", "docs/concepts/stack-app", "docs/concepts/backend-integration", "docs/going-further/local-development", @@ -71,23 +69,9 @@ "docs/customization/custom-styles", "docs/customization/dark-mode", "docs/customization/internationalization", - { - "group": "Page Examples", - "pages": [ - "docs/customization/page-examples", - "docs/customization/page-examples/forgot-password", - "docs/customization/page-examples/password-reset", - "docs/customization/page-examples/sign-in", - "docs/customization/page-examples/sign-up" - ] - } + "docs/customization/page-examples" ] - }, - "docs/concepts/custom-user-data", - "docs/concepts/sign-up-rules", - "docs/concepts/jwt", - "docs/concepts/user-onboarding", - "docs/concepts/team-selection" + } ] }, { @@ -101,6 +85,7 @@ { "group": "Auth Providers", "pages": [ + "docs/apps/auth-providers", "docs/concepts/auth-providers", "docs/concepts/auth-providers/apple", "docs/concepts/auth-providers/bitbucket", @@ -117,18 +102,31 @@ "docs/concepts/auth-providers/two-factor-auth", "docs/concepts/auth-providers/x-twitter" ] - } + }, + "docs/concepts/sign-up-rules", + "docs/others/cli-authentication" + ] + }, + "docs/concepts/user-onboarding", + { + "group": "Teams", + "icon": "users", + "pages": [ + "docs/apps/orgs-and-teams", + "docs/concepts/orgs-and-teams", + "docs/concepts/team-selection" ] }, - "docs/apps/emails", - "docs/apps/payments", - "docs/apps/analytics", - "docs/apps/api-keys", - "docs/apps/data-vault", - "docs/apps/launch-checklist", "docs/apps/permissions", - "docs/apps/orgs-and-teams", - "docs/apps/webhooks" + "docs/apps/api-keys", + "docs/apps/payments", + "docs/apps/emails", + "docs/concepts/emails", + "docs/apps/data-vault", + "docs/apps/webhooks", + "docs/apps/launch-checklist", + "docs/going-further/working-with-ai", + "docs/apps/analytics" ] }, { @@ -136,7 +134,7 @@ "pages": [ "docs/others/supabase", "docs/others/convex", - "docs/others/mcp-setup" + "docs/others/vercel" ] }, { @@ -144,6 +142,15 @@ "pages": [ "docs/others/self-host", "docs/others/cli-authentication", + "docs/others/mcp-setup", + { + "group": "Tutorials", + "pages": [ + "docs/others/tutorials/build-a-saas-with-stack-auth", + "docs/others/tutorials/build-a-team-based-app", + "docs/others/tutorials/ship-production-ready-auth" + ] + }, "docs/going-further/showcase" ] } @@ -594,10 +601,5 @@ "robots": "noindex" } }, - "redirects": [ - { - "source": "/docs/overview", - "destination": "/" - } - ] + "redirects": [] } diff --git a/docs-mintlify/docs/apps/launch-checklist.mdx b/docs-mintlify/docs/apps/launch-checklist.mdx index cb5db2627..40e0ed207 100644 --- a/docs-mintlify/docs/apps/launch-checklist.mdx +++ b/docs-mintlify/docs/apps/launch-checklist.mdx @@ -1,43 +1,134 @@ --- title: "Launch Checklist" -description: "A guided checklist to make sure your project is ready for production" +description: "Steps to prepare Stack for production use" icon: "clipboard-check" --- -The Launch Checklist is a built-in dashboard tool that walks you through everything you need to verify before going live. It checks your project configuration and guides you through each requirement, so nothing gets missed on launch day. +Stack makes development easy with various default settings, but these settings need to be optimized for security and user experience when moving to production. Here's a checklist of things you need to do before switching to production mode: -Enable it from the **App Store** in your [Stack Auth dashboard](https://app.stack-auth.com), then find it in your project sidebar. +## Domains -## What it checks +By default, Stack allows all localhost paths as valid callback URLs. This is convenient for development but poses a security risk in production because attackers could use their own domains as callback URLs to intercept sensitive information. Therefore, in production, Stack must know your domain (e.g., `https://your-website.com`) and only allow callbacks from those domains. -The checklist is organized into four areas, each with specific sub-tasks: +Follow these steps when you're ready to push your application to production: -### Domains & callbacks + + + Navigate to the `Domain & Handlers` tab in the Stack dashboard. If you haven't configured your handler, you can leave it as the default. (Learn more about handlers [here](../sdk/objects/stack-app)). + + + For enhanced security, disable the `Allow all localhost callbacks for development` option. + + -- **Production domain saved** — At least one domain must be configured in your project's domain settings. -- **Localhost callbacks disabled** — The "Allow localhost" option must be turned off. Localhost should not be reachable in production. +## OAuth providers -### OAuth providers +Stack uses shared OAuth keys for development to simplify setup when using "Sign in with Google/GitHub/etc." However, this isn't secure for production as it displays "Stack Development" on the providers' consent screens, making it unclear to users if the OAuth request is genuinely from your site. Thus, you should configure your own OAuth keys with the providers and connect them to Stack. -- **Custom client IDs and secrets** — Any OAuth provider you've enabled (Google, GitHub, etc.) must use your own client credentials, not the shared defaults that Stack Auth provides for development. Shared credentials are not suitable for production. +To use your own OAuth provider setups in production, follow these steps for each provider you use: -The checklist includes expandable guides with callback URLs and setup instructions for each provider. + + + On the provider's website, create an OAuth app and set the callback URL to the corresponding Stack callback URL. Copy the client ID and client secret. -### Email server + + + [Google OAuth Setup Guide](https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name-.) -- **Custom SMTP or Resend configured** — Your project must use your own email server, not Stack Auth's shared email service. This ensures reliable deliverability and lets you send from your own domain. + Callback URL: -### Production mode + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/google + ``` + + + [GitHub OAuth Setup Guide](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) -- **Automated checks passing** — Stack Auth runs a set of automated validations on your project config. These verify that all trusted domains use HTTPS, are not localhost, and are not raw IP addresses. -- **Production mode enabled** — Once all checks pass, you can flip the production mode toggle directly from the checklist. This locks down your project to production-ready settings. + Callback URL: - - You can toggle production mode on and off directly from the Launch Checklist page. When you enable it for the first time, you'll get a confetti celebration. - + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/github + ``` + + + [Facebook OAuth Setup Guide](https://developers.facebook.com/docs/development/create-an-app/facebook-login-use-case) -## How it works + Callback URL: -The Launch Checklist doesn't have its own API — it reads your existing project configuration and evaluates readiness based on the settings you've already configured elsewhere (domains, OAuth providers, email server, etc.). Each task links directly to the relevant settings page so you can fix issues in context. + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/facebook + ``` + + + [Microsoft Azure OAuth Setup Guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) -Progress is tracked visually with a progress bar and completion indicators. The checklist highlights the next action you need to take, making it easy to work through the tasks in order. + Callback URL: + + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/microsoft + ``` + + + [Spotify OAuth Setup Guide](https://developer.spotify.com/documentation/general/guides/app-settings/) + + Callback URL: + + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/spotify + ``` + + + [Gitlab OAuth Setup Guide](https://docs.gitlab.com/ee/integration/oauth_provider.html) + + Callback URL: + + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/gitlab + ``` + + + [Bitbucket OAuth Setup Guide](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud) + + Callback URL: + + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/bitbucket + ``` + + + [LinkedIn OAuth Setup Guide](https://learn.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow?context=linkedin%2Fcontext&tabs=HTTPS1) + + Callback URL: + + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/linkedin + ``` + + + [X OAuth Setup Guide](https://developer.x.com/en/docs/apps/overview) + + Callback URL: + + ``` + https://api.stack-auth.com/api/v1/auth/oauth/callback/x + ``` + + + + + Go to the `Auth Methods` section in the Stack dashboard, open the provider's settings, switch from shared keys to custom keys, and enter the client ID and client secret. + + + +## Email server + +For development, Stack uses a shared email server, which sends emails from Stack's domain. This is not ideal for production as users may not trust emails from an unfamiliar domain. You should set up an email server connected to your own domain. + +Steps to connect your own email server with Stack: + +1. **Setup Email Server**: Configure your own email server and connect it to your domain (this step is beyond Stack's documentation scope). +2. **Configure Stack's Email Settings**: Navigate to the `Emails` section in the Stack dashboard, click `Edit` in the `Email Server` section, switch from `Shared` to `Custom SMTP server`, enter your SMTP configurations, and save. + +## Enabling production mode + +After completing the steps above, you can enable production mode on the `Project Settings` tab in the Stack dashboard, ensuring that your website runs securely with Stack in a production environment. diff --git a/docs-mintlify/docs/apps/oauth.mdx b/docs-mintlify/docs/apps/oauth.mdx index f3160561b..304b0f22b 100644 --- a/docs-mintlify/docs/apps/oauth.mdx +++ b/docs-mintlify/docs/apps/oauth.mdx @@ -1,6 +1,7 @@ --- title: "OAuth" description: "Managing third-party OAuth access tokens" +sidebarTitle: "Authentication" --- Stack has good support for working with OAuth and OIDC providers, such as Google, Facebook, Microsoft, and others. diff --git a/docs-mintlify/docs/apps/orgs-and-teams.mdx b/docs-mintlify/docs/apps/orgs-and-teams.mdx index 6807f2368..a125f613f 100644 --- a/docs-mintlify/docs/apps/orgs-and-teams.mdx +++ b/docs-mintlify/docs/apps/orgs-and-teams.mdx @@ -1,6 +1,7 @@ --- title: "Orgs and Teams" description: "Manage teams and team members" +sidebarTitle: Teams icon: "users" --- diff --git a/docs-mintlify/docs/apps/permissions.mdx b/docs-mintlify/docs/apps/permissions.mdx index 7ff326a45..e247ab6ee 100644 --- a/docs-mintlify/docs/apps/permissions.mdx +++ b/docs-mintlify/docs/apps/permissions.mdx @@ -1,6 +1,7 @@ --- title: "RBAC Permissions" description: "Control what each user can do and access within your application" +sidebarTitle: RBAC icon: "user-cog" --- diff --git a/docs-mintlify/docs/concepts/auth-providers/two-factor-auth.mdx b/docs-mintlify/docs/concepts/auth-providers/two-factor-auth.mdx index df1072e7d..d1085787b 100644 --- a/docs-mintlify/docs/concepts/auth-providers/two-factor-auth.mdx +++ b/docs-mintlify/docs/concepts/auth-providers/two-factor-auth.mdx @@ -1,6 +1,7 @@ --- title: "Two-Factor Authentication (2FA)" description: "Learn how Two-Factor Authentication works with Stack Auth" +sidebarTitle: "Two-Factor Auth" --- This guide explains how Two-Factor Authentication (2FA) works with Stack Auth. 2FA adds an extra layer of security by requiring users to provide a verification code in addition to their password. diff --git a/docs-mintlify/docs/concepts/backend-integration.mdx b/docs-mintlify/docs/concepts/backend-integration.mdx index 9c328786e..6c926c845 100644 --- a/docs-mintlify/docs/concepts/backend-integration.mdx +++ b/docs-mintlify/docs/concepts/backend-integration.mdx @@ -1,6 +1,7 @@ --- title: "Backend Integration" description: "Integrate Stack Auth with your own server with the REST APIs" +sidebarTitle: "Integrating with backends" --- To authenticate your endpoints, you need to send the user's access token in the headers of the request to your server, and then make a request to Stack's server API to verify the user's identity. diff --git a/docs-mintlify/docs/concepts/emails.mdx b/docs-mintlify/docs/concepts/emails.mdx index 5ace26d2e..6a218b27a 100644 --- a/docs-mintlify/docs/concepts/emails.mdx +++ b/docs-mintlify/docs/concepts/emails.mdx @@ -1,6 +1,7 @@ --- title: "Emails" description: "Send custom emails to your users with Stack Auth's email system." +sidebarTitle: Email API --- Stack Auth provides emails that allows you to send custom emails to your users. The system supports both custom HTML emails and template-based emails with theming. diff --git a/docs-mintlify/docs/concepts/orgs-and-teams.mdx b/docs-mintlify/docs/concepts/orgs-and-teams.mdx index 332a8ac2e..e398da6b6 100644 --- a/docs-mintlify/docs/concepts/orgs-and-teams.mdx +++ b/docs-mintlify/docs/concepts/orgs-and-teams.mdx @@ -1,6 +1,7 @@ --- title: "Orgs and Teams" description: "Manage teams and team members" +sidebarTitle: "Team Settings" --- Teams provide a structured way to group users and manage their permissions. Users can belong to multiple teams simultaneously, allowing them to represent departments, B2B customers, or projects. diff --git a/docs-mintlify/docs/concepts/stack-app.mdx b/docs-mintlify/docs/concepts/stack-app.mdx index 5b43e61b2..72f7906e5 100644 --- a/docs-mintlify/docs/concepts/stack-app.mdx +++ b/docs-mintlify/docs/concepts/stack-app.mdx @@ -1,6 +1,7 @@ --- title: "Stack App" description: "The most important object of your Stack project" +sidebarTitle: "The StackApp Object" --- By now, you may have seen the `useStackApp()` hook and the `stackServerApp` variable. Both return a `StackApp`, of type `StackClientApp` and `StackServerApp` respectively. diff --git a/docs-mintlify/docs/concepts/team-selection.mdx b/docs-mintlify/docs/concepts/team-selection.mdx index 7a55410d9..e77d17582 100644 --- a/docs-mintlify/docs/concepts/team-selection.mdx +++ b/docs-mintlify/docs/concepts/team-selection.mdx @@ -1,6 +1,7 @@ --- title: "Team Selection" description: "" +sidebarTitle: Selected Teams --- A user can be a member of multiple teams, so most websites using teams will need a way to select a "current team" that the user is working on. There are two primary methods to accomplish this: diff --git a/docs-mintlify/docs/concepts/user-onboarding.mdx b/docs-mintlify/docs/concepts/user-onboarding.mdx index b22c5f6a5..72149f3de 100644 --- a/docs-mintlify/docs/concepts/user-onboarding.mdx +++ b/docs-mintlify/docs/concepts/user-onboarding.mdx @@ -1,6 +1,7 @@ --- title: "User Onboarding" description: "Implementing a user onboarding page and collecting information on sign-up" +sidebarTitle: Onboarding --- By default, Stack Auth collects information such as email addresses from OAuth providers. Sometimes, you may want to collect additional information from users during sign-up, for example a name or address. diff --git a/docs-mintlify/docs/customization/custom-pages.mdx b/docs-mintlify/docs/customization/custom-pages.mdx index 6ed701019..58fc4749e 100644 --- a/docs-mintlify/docs/customization/custom-pages.mdx +++ b/docs-mintlify/docs/customization/custom-pages.mdx @@ -1,6 +1,7 @@ --- title: Custom Pages description: Take full control over the layout and logic flow of authentication pages in your application. +sidebarTitle: Component customization --- Custom pages allow you to take full control over the layout and logic flow of authentication pages in your application. Instead of using the default pages provided by Stack Auth, you can build your own using our built-in components or low-level functions. diff --git a/docs-mintlify/docs/faq.mdx b/docs-mintlify/docs/faq.mdx index 09c4e3529..3a1747bbc 100644 --- a/docs-mintlify/docs/faq.mdx +++ b/docs-mintlify/docs/faq.mdx @@ -2,7 +2,6 @@ title: FAQ description: Frequently asked questions about Stack sidebarTitle: FAQ -icon: circle-question --- # FAQ diff --git a/docs-mintlify/docs/getting-started/components.mdx b/docs-mintlify/docs/getting-started/components.mdx index 33f4ae883..4dab4b4b5 100644 --- a/docs-mintlify/docs/getting-started/components.mdx +++ b/docs-mintlify/docs/getting-started/components.mdx @@ -2,7 +2,6 @@ title: Components description: Pre-built Next.js components to make your life easier sidebarTitle: Components -icon: "puzzle-piece" --- # Components diff --git a/docs-mintlify/docs/getting-started/production.mdx b/docs-mintlify/docs/getting-started/production.mdx deleted file mode 100644 index 1cd590bc3..000000000 --- a/docs-mintlify/docs/getting-started/production.mdx +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: Production -description: Steps to prepare Stack for production use -sidebarTitle: Production -icon: "rocket" ---- - -# Production - -Stack makes development easy with various default settings, but these settings need to be optimized for security and user experience when moving to production. Here's a checklist of things you need to do before switching to production mode: - -## Domains - -By default, Stack allows all localhost paths as valid callback URLs. This is convenient for development but poses a security risk in production because attackers could use their own domains as callback URLs to intercept sensitive information. Therefore, in production, Stack must know your domain (e.g., `https://your-website.com`) and only allow callbacks from those domains. - -Follow these steps when you're ready to push your application to production: - - - - Navigate to the `Domain & Handlers` tab in the Stack dashboard. If you haven't configured your handler, you can leave it as the default. (Learn more about handlers [here](../sdk/objects/stack-app)). - - - For enhanced security, disable the `Allow all localhost callbacks for development` option. - - - -## OAuth providers - -Stack uses shared OAuth keys for development to simplify setup when using "Sign in with Google/GitHub/etc." However, this isn't secure for production as it displays "Stack Development" on the providers' consent screens, making it unclear to users if the OAuth request is genuinely from your site. Thus, you should configure your own OAuth keys with the providers and connect them to Stack. - -To use your own OAuth provider setups in production, follow these steps for each provider you use: - - - - On the provider's website, create an OAuth app and set the callback URL to the corresponding Stack callback URL. Copy the client ID and client secret. - - - - [Google OAuth Setup Guide](https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name-.) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/google - ``` - - - [GitHub OAuth Setup Guide](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/github - ``` - - - [Facebook OAuth Setup Guide](https://developers.facebook.com/docs/development/create-an-app/facebook-login-use-case) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/facebook - ``` - - - [Microsoft Azure OAuth Setup Guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/microsoft - ``` - - - [Spotify OAuth Setup Guide](https://developer.spotify.com/documentation/general/guides/app-settings/) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/spotify - ``` - - - [Gitlab OAuth Setup Guide](https://docs.gitlab.com/ee/integration/oauth_provider.html) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/gitlab - ``` - - - [Bitbucket OAuth Setup Guide](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/bitbucket - ``` - - - [LinkedIn OAuth Setup Guide](https://learn.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow?context=linkedin%2Fcontext&tabs=HTTPS1) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/linkedin - ``` - - - [X OAuth Setup Guide](https://developer.x.com/en/docs/apps/overview) - - Callback URL: - - ``` - https://api.stack-auth.com/api/v1/auth/oauth/callback/x - ``` - - - - - Go to the `Auth Methods` section in the Stack dashboard, open the provider's settings, switch from shared keys to custom keys, and enter the client ID and client secret. - - - -## Email server - -For development, Stack uses a shared email server, which sends emails from Stack's domain. This is not ideal for production as users may not trust emails from an unfamiliar domain. You should set up an email server connected to your own domain. - -Steps to connect your own email server with Stack: - -1. **Setup Email Server**: Configure your own email server and connect it to your domain (this step is beyond Stack's documentation scope). -2. **Configure Stack's Email Settings**: Navigate to the `Emails` section in the Stack dashboard, click `Edit` in the `Email Server` section, switch from `Shared` to `Custom SMTP server`, enter your SMTP configurations, and save. - -## Enabling production mode - -After completing the steps above, you can enable production mode on the `Project Settings` tab in the Stack dashboard, ensuring that your website runs securely with Stack in a production environment. diff --git a/docs-mintlify/docs/getting-started/setup.mdx b/docs-mintlify/docs/getting-started/setup.mdx index d14050954..cb73c8a01 100644 --- a/docs-mintlify/docs/getting-started/setup.mdx +++ b/docs-mintlify/docs/getting-started/setup.mdx @@ -2,7 +2,6 @@ title: Setup description: Install and configure Stack Auth for your project sidebarTitle: Setup -icon: "gear" --- # Setup diff --git a/docs-mintlify/docs/getting-started/users.mdx b/docs-mintlify/docs/getting-started/users.mdx index f34cb61ca..68d32faa1 100644 --- a/docs-mintlify/docs/getting-started/users.mdx +++ b/docs-mintlify/docs/getting-started/users.mdx @@ -1,8 +1,7 @@ --- title: User Fundamentals description: Access and manage user information within custom components -sidebarTitle: User Fundamentals -icon: "users" +sidebarTitle: Users --- import { UserFieldsTable } from "/snippets/user-fields-table.jsx"; diff --git a/docs-mintlify/docs/getting-started/vite-example.mdx b/docs-mintlify/docs/getting-started/vite-example.mdx index a6c8752f4..f1ec5cf0a 100644 --- a/docs-mintlify/docs/getting-started/vite-example.mdx +++ b/docs-mintlify/docs/getting-started/vite-example.mdx @@ -1,8 +1,7 @@ --- title: Vite JavaScript Example description: How to integrate Stack Auth with Vite and other JavaScript frameworks -sidebarTitle: Vite Example -icon: "bolt" +sidebarTitle: Customization --- # Vite JavaScript Example diff --git a/docs-mintlify/docs/going-further/working-with-ai.mdx b/docs-mintlify/docs/going-further/working-with-ai.mdx index ef5c7a43d..6e46f86d1 100644 --- a/docs-mintlify/docs/going-further/working-with-ai.mdx +++ b/docs-mintlify/docs/going-further/working-with-ai.mdx @@ -1,6 +1,7 @@ --- title: "Working with AI" description: "Use AI-powered tools and integrations with Stack Auth to accelerate your development workflow" +sidebarTitle: "Catalyst" --- This page is under construction. Check back soon for guidance on integrating Stack Auth with AI-powered development tools. diff --git a/docs-mintlify/docs/others/tutorials/build-a-saas-with-stack-auth.mdx b/docs-mintlify/docs/others/tutorials/build-a-saas-with-stack-auth.mdx new file mode 100644 index 000000000..9aee84cdd --- /dev/null +++ b/docs-mintlify/docs/others/tutorials/build-a-saas-with-stack-auth.mdx @@ -0,0 +1,14 @@ +--- +title: Build a SaaS with Stack Auth +description: End-to-end tutorial stub for building a SaaS app with Stack Auth. +--- + +This tutorial is coming soon. + +## Planned coverage + +- Project setup and auth bootstrapping +- App onboarding, teams, and permissions +- Production deployment checklist + +If you want this prioritized, open a request in our community channels and include your stack details. diff --git a/docs-mintlify/docs/others/tutorials/build-a-team-based-app.mdx b/docs-mintlify/docs/others/tutorials/build-a-team-based-app.mdx new file mode 100644 index 000000000..d753114f7 --- /dev/null +++ b/docs-mintlify/docs/others/tutorials/build-a-team-based-app.mdx @@ -0,0 +1,12 @@ +--- +title: Build a Team-Based App +description: Tutorial stub for implementing teams and role-based access with Stack Auth. +--- + +This tutorial is coming soon. + +## Planned coverage + +- Team creation and membership flows +- Team selection patterns +- RBAC permission modeling for multi-tenant apps diff --git a/docs-mintlify/docs/others/tutorials/ship-production-ready-auth.mdx b/docs-mintlify/docs/others/tutorials/ship-production-ready-auth.mdx new file mode 100644 index 000000000..e76cef77e --- /dev/null +++ b/docs-mintlify/docs/others/tutorials/ship-production-ready-auth.mdx @@ -0,0 +1,12 @@ +--- +title: Ship Production-Ready Auth +description: Tutorial stub for hardening a Stack Auth deployment before launch. +--- + +This tutorial is coming soon. + +## Planned coverage + +- Environment and key management strategy +- Provider, email, and webhook production checks +- Launch readiness and rollback planning diff --git a/docs-mintlify/docs/others/vercel.mdx b/docs-mintlify/docs/others/vercel.mdx new file mode 100644 index 000000000..cf7d31442 --- /dev/null +++ b/docs-mintlify/docs/others/vercel.mdx @@ -0,0 +1,57 @@ +--- +title: Vercel +description: Deploy your Stack Auth project on Vercel with the dashboard integration flow. +--- + +This guide mirrors the Vercel integration flow in the Stack Auth dashboard app. + +## What this integration covers + +- Generate Stack Auth keys for your project +- Add the required environment variables in Vercel +- Redeploy and verify the auth flow + +## Setup + + + + In the Vercel dashboard, open the project you want to connect to Stack Auth. + + [Open Vercel dashboard](https://vercel.com/dashboard) + + + + In your Stack dashboard, open the **Vercel Integration** app and generate keys for your project. + + This produces a project ID plus API keys that you can paste into Vercel. + + + + In Vercel, go to **Project -> Settings -> Environment Variables** and add: + + - `NEXT_PUBLIC_STACK_PROJECT_ID` + - `NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY` + - `STACK_SECRET_SERVER_KEY` + + Add `NEXT_PUBLIC_STACK_API_URL` only if you are not using the default hosted Stack API. + + + + Trigger a new deployment so Vercel picks up the new environment variables. + + If you use both preview and production environments, make sure both are updated. + + + + Open your deployed app and test authentication. + + A quick check is to visit `/handler/signup` and confirm the sign-up flow loads correctly. + + + +## Notes + +- Keys are sensitive. Store server keys only in server-side environment variables. +- If authentication fails after setup, confirm variable names are exact and redeploy again. + +For additional Vercel details, see [Vercel environment variable docs](https://vercel.com/docs/environment-variables). diff --git a/docs-mintlify/index.mdx b/docs-mintlify/index.mdx index 8d5ff0464..015608021 100644 --- a/docs-mintlify/index.mdx +++ b/docs-mintlify/index.mdx @@ -1,6 +1,7 @@ --- title: "Welcome" description: "Stack Auth documentation for setup, components, SDK usage, and REST APIs." +sidebarTitle: "Overview" ---