instances:
  - url: https://stack-auth.docs.buildwithfern.com
    custom-domain: docs.stack-auth.com
    edit-this-page:
      github:
        owner: stack-auth
        repo: stack
        branch: dev/docs
title: Stack Auth Documentation
js: ./custom-script.js

tabs:
  documentation:
    display-name: Documentation
    icon: fa-solid fa-home
    slug: docs
  components:
    display-name: Components
    icon: fa-solid fa-puzzle
    slug: components
  sdk:
    display-name: SDK Reference
    icon: fa-solid fa-hammer
    slug: sdk
  api:
    display-name: REST API & Webhooks
    icon: fa-solid fa-code
    slug: rest-api

navigation:
  - tab: documentation
    layout: 
      - page: Overview
        icon: fa-regular fa-globe
        path: ./docs/pages/overview.mdx
      - page: FAQ
        icon: fa-regular fa-circle-question
        path: ./docs/pages/faq.mdx
      - section: Getting Started
        contents:
          - page: Installation & Setup
            icon: fa-regular fa-download
            path: ./docs/pages/getting-started/setup.mdx
          - page: Components
            icon: fa-regular fa-puzzle
            path: ./docs/pages/getting-started/components.mdx
          - page: Users
            icon: fa-regular fa-address-book
            path: ./docs/pages/getting-started/users.mdx
          - page: Going to Production
            icon: fa-regular fa-rocket
            path: ./docs/pages/getting-started/production.mdx
      - section: Concepts
        contents:
          - page: The StackApp Object
            icon: fa-regular fa-folder-gear
            path: ./docs/pages/concepts/stack-app.mdx
          - page: Custom User Data
            icon: fa-regular fa-user-pen
            path: ./docs/pages/concepts/custom-user-data.mdx
          - page: User Onboarding
            icon: fa-regular fa-user-check
            path: ./docs/pages/concepts/user-onboarding.mdx
          - page: Connected OAuth Accounts
            icon: fa-regular fa-link
            path: ./docs/pages/concepts/oauth.mdx
          - page: Teams
            icon: fa-regular fa-users
            path: ./docs/pages/concepts/orgs-and-teams.mdx
          - page: Selecting a Team
            icon: fa-regular fa-exchange
            path: ./docs/pages/concepts/team-selection.mdx
          - page: Permissions & RBAC
            icon: fa-regular fa-user-lock
            path: ./docs/pages/concepts/permissions.mdx
          - page: Webhooks
            icon: fa-regular fa-webhook
            path: ./docs/pages/concepts/webhooks.mdx
          - page: Backend Integration
            icon: fa-regular fa-network-wired
            path: ./docs/pages/concepts/backend-integration.mdx
      - section: Customization
        contents:
          - page: Dark/Light Mode
            icon: fa-regular fa-circle-half-stroke
            path: ./docs/pages/customization/dark-mode.mdx
          - page: Colors and Styles
            icon: fa-regular fa-paint-brush
            path: ./docs/pages/customization/custom-styles.mdx
          - page: Internationalization
            icon: fa-regular fa-language
            path: ./docs/pages/customization/internationalization.mdx
          # - page: Customize Emails
          #   icon: fa-regular fa-envelope
          - page: Custom Layouts and Pages
            icon: fa-regular fa-table-layout
            path: ./docs/pages/customization/custom-pages.mdx
          - section: Custom Page Examples
            icon: fa-regular fa-files
            contents:
              - page: Sign In
                path: ./docs/pages/customization/page-examples/sign-in.mdx
              - page: Sign Up
                path: ./docs/pages/customization/page-examples/sign-up.mdx
      - section: Others
        contents:
          - page: Supabase Integration
            icon: fa-regular fa-bolt
            path: ./docs/pages/others/supabase.mdx
          - page: Self-Hosting
            icon: fa-regular fa-house-laptop
            path: ./docs/pages/others/self-host.mdx
  - tab: components
    layout: 
      - page: All Components
        icon: fa-regular fa-globe
        path: ./docs/pages/components/overview.mdx
      - section: Components
        contents:
          - page: <UserButton />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/user-button.mdx
          - page: <SelectedTeamSwitcher />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/selected-team-switcher.mdx
          - page: <AccountSettings />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/account-settings.mdx
          - page: <SignIn />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/sign-in.mdx
          - page: <SignUp />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/sign-up.mdx
          - page: <CredentialSignIn />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/credential-sign-in.mdx
          - page: <CredentialSignUp />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/credential-sign-up.mdx
          - page: <OAuthButton />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/oauth-button.mdx
          - page: <OAuthButtonGroup />
            icon: fa-solid fa-square-code
            path: ./docs/pages/components/oauth-button-group.mdx
      - section: Utilities
        contents:
          - page: <StackHandler />
            icon: fa-solid fa-square-u
            path: ./docs/pages/components/stack-handler.mdx
          - page: <StackProvider />
            icon: fa-solid fa-square-u
            path: ./docs/pages/components/stack-provider.mdx
          - page: <StackTheme />
            icon: fa-solid fa-square-u
            path: ./docs/pages/components/stack-theme.mdx
  - tab: sdk
    layout:
      - page: SDK Overview
        icon: fa-regular fa-globe
        path: ./docs/pages/sdk/overview.mdx
      - section: Objects
        contents:
          - section: StackApp
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/objects/stack-app.mdx
            contents:
              - link: StackClientApp
                icon: fa-duotone fa-square-t
                href: /sdk/objects/stack-app#stackclientapp
              - link: StackServerApp
                icon: fa-duotone fa-square-t
                href: /sdk/objects/stack-app#stackserverapp
      - section: Types
        contents:
          - section: ContactChannel
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/contact-channel.mdx
            contents:
              - link: ContactChannel
                icon: fa-duotone fa-square-t
                href: /sdk/types/contact-channel#contactchannel
              - link: ServerContactChannel
                icon: fa-duotone fa-square-t
                href: /sdk/types/contact-channel#servercontactchannel
          - page: Project
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/project.mdx
          - section: Team
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/team.mdx
            contents:
              - link: Team
                icon: fa-duotone fa-square-t
                href: /sdk/types/team#team
              - link: ServerTeam
                icon: fa-duotone fa-square-t
                href: /sdk/types/team#serverteam
          - page: TeamPermission
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/team-permission.mdx
          - section: TeamProfile
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/team-profile.mdx
            contents:
              - link: TeamProfile
                icon: fa-duotone fa-square-t
                href: /sdk/types/team-profile#teamprofile
              - link: ServerTeamProfile
                icon: fa-duotone fa-square-t
                href: /sdk/types/team-profile#serverteamprofile
          - section: TeamUser
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/team-user.mdx
            contents:
              - link: TeamUser
                icon: fa-duotone fa-square-t
                href: /sdk/types/team-user#teamuser
              - link: ServerTeamUser
                icon: fa-duotone fa-square-t
                href: /sdk/types/team-user#serverteamuser
          - section: User
            icon: fa-duotone fa-square-t
            path: ./docs/pages/sdk/types/user.mdx
            contents:
              - link: CurrentUser
                icon: fa-duotone fa-square-t
                href: /sdk/types/user#currentuser
              - link: ServerUser
                icon: fa-duotone fa-square-t
                href: /sdk/types/user#serveruser
              - link: CurrentServerUser
                icon: fa-duotone fa-square-t
                href: /sdk/types/user#currentserveruser
          # - section: ConnectedAccount
          #   path: ./docs/pages/sdk/types/connected-account.mdx
      - section: Hooks
        contents:
          - page: useStackApp()
            icon: fa-duotone fa-square-h
            path: ./docs/pages/sdk/hooks/use-stack-app.mdx
          - page: useUser()
            icon: fa-duotone fa-square-h
            path: ./docs/pages/sdk/hooks/use-user.mdx
  - tab: api
    layout: 
      - page: API Overview
        icon: fa-regular fa-globe
        path: ./docs/pages/rest-api/overview.mdx
      - api: Client API
        slug: client
        api-name: client
      - api: Server API
        slug: server
        api-name: server
      - api: Webhooks
        slug: webhooks
        api-name: webhooks
      # - api: Admin API Reference
      #   slug: admin
      #   api-name: admin

navbar-links:
  - type: secondary
    text: Discord
    url: https://discord.stack-auth.com
  - type: secondary
    text: GitHub
    url: https://github.com/stack-auth/stack
  - type: primary
    text: Dashboard
    url: https://app.stack-auth.com

colors:
  accentPrimary: 
    light: '#000000'
    dark: '#FFFFFF'
  background: 
    light: '#FFFFFF'
    dark: '#000000'
  sidebar-background: 
    light: '#FCFCFC'
    dark: '#090909'
  card-background: 
    light: '#FCFCFC'
    dark: '#090909'
layout:
  page-width: full
  content-width: 45rem
  disable-header: false
  header-height: 60px
  sidebar-width: 300px
favicon: ./docs/assets/favicon.ico
logo:
  light: ./docs/assets/logo-light-mode.svg
  dark: ./docs/assets/logo-dark-mode.svg
  height: 28
  href: https://stack-auth.com
css: ./style.css