stack/docs/fern/docs.yml

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
  sdk:
    display-name: SDK Reference
    icon: fa-solid fa-hammer
    slug: sdk
  api:
    display-name: API Reference
    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: 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: Local Development
          #   icon: fa-regular fa-laptop
      - 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: 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
  - tab: sdk
    layout: 
      - page: SDK Overview
        icon: fa-regular fa-globe
        path: ./docs/pages/sdk/overview.mdx
      - section: Classes
        contents:
          - page: CurrentUser
            path: ./docs/pages/sdk/current-user.mdx
          - page: StackApp
            path: ./docs/pages/sdk/stack-app.mdx
      - section: Hooks
        contents:
          - page: useStackApp
            path: ./docs/pages/sdk/use-stack-app.mdx
          - page: useUser
            path: ./docs/pages/sdk/use-user.mdx
      - section: Components
        contents:
          - page: StackHandler
            path: ./docs/pages/sdk/stack-handler.mdx
          - page: SignIn
            path: ./docs/pages/sdk/sign-in.mdx
          - page: SignUp
            path: ./docs/pages/sdk/sign-up.mdx
          - page: SignOut
            path: ./docs/pages/sdk/sign-out.mdx

  - tab: api
    layout: 
      - page: API Overview
        icon: fa-regular fa-globe
        path: ./docs/pages/rest-api/auth.mdx
      - page: Examples
        icon: fa-regular fa-code
        path: ./docs/pages/rest-api/examples.mdx
      - api: Client API Reference
        slug: client
        api-name: client
      - api: Server API Reference
        slug: server
        api-name: server
      - api: Webhooks API Reference
        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: 40rem
  disable-header: false
  header-height: 60px
favicon: ./docs/assets/favicon.ico
logo:
  light: ./docs/assets/logo-light-mode.svg
  dark: ./docs/assets/logo-dark-mode.svg
  height: 28