docs.yml

navigation:
  - section: Getting started
    contents:
      - page: Overview
        path: ./pages/getting-started/overview.mdx
      - page: How it works
        path: ./pages/getting-started/how-it-works.mdx
      - page: Quickstart
        path: ./pages/getting-started/quickstart.mdx
      - page: Self-service setup
        path: ./pages/getting-started/self-service-setup.mdx
        hidden: true
      - page: Project structure
        path: ./pages/getting-started/project-structure.mdx
      - link: Customer showcase
        href: https://buildwithfern.com/showcase#docs-customers.alldocs-features
  - changelog: ./pages/changelog
    icon: fa-regular fa-clock-rotate-left
  - section: Configuration
    contents:
      - page: Site-level settings
        path: ./pages/customization/site-level-settings.mdx
      - page: Navigation
        path: ./pages/navigation/overview.mdx
      - page: Tabs and tab variants
        path: ./pages/navigation/tabs.mdx
        slug: tabs
      - page: Versions
        path: ./pages/navigation/versions.mdx
      - page: Products
        path: ./pages/navigation/products.mdx
      - page: Changelog pages
        path: ./pages/navigation/changelogs.mdx
        slug: changelogs
      - page: Page-level settings
        path: ./pages/customization/frontmatter.mdx
  - section: Writing content
    contents:
      - page: Markdown basics
        path: ./pages/component-library/writing-content/markdown-basics.mdx
        slug: markdown-basics
      - page: Rich media in Markdown
        path: ./pages/component-library/writing-content/markdown-media.mdx
        slug: markdown-media
      - section: Components
        contents:
          - page: Overview
            path: ./pages/component-library/default-components/overview.mdx
            icon: fa-duotone fa-book
          - page: Accordion
            path: ./pages/component-library/default-components/accordions.mdx
            icon: fa-duotone fa-chevron-down
            slug: accordions
          - page: Anchor
            path: ./pages/component-library/default-components/anchor.mdx
            icon: fa-duotone fa-link
          - page: Aside
            path: ./pages/component-library/default-components/aside.mdx
            icon: fa-regular fa-comment-dots
          - page: Badge
            path: ./pages/component-library/default-components/badges.mdx
            icon: fa-regular fa-ribbon
            slug: badges
          - page: Button
            path: ./pages/component-library/default-components/button.mdx
            icon: fa-duotone fa-arrow-pointer
          - page: Callout
            path: ./pages/component-library/default-components/callouts.mdx
            icon: fa-duotone fa-exclamation-triangle
            slug: callouts
          - page: Card
            path: ./pages/component-library/default-components/cards.mdx
            icon: fa-duotone fa-id-card
            slug: cards
          - page: Code block
            path: ./pages/component-library/default-components/code-blocks.mdx
            icon: fa-duotone fa-code
            slug: code-blocks
          - page: Copy
            path: ./pages/component-library/default-components/copy.mdx
            icon: fa-duotone fa-copy
          - page: Download
            path: ./pages/component-library/default-components/download.mdx
            icon: fa-duotone fa-download
          - page: Endpoint request snippet
            path: ./pages/component-library/default-components/endpoint-request-snippet.mdx
            icon: fa-duotone fa-arrow-up
            slug: request-snippet
          - page: Endpoint response snippet
            path: ./pages/component-library/default-components/endpoint-response-snippet.mdx
            icon: fa-duotone fa-arrow-down
            slug: response-snippet
          - page: Endpoint schema snippet
            path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx
            icon: fa-duotone fa-sitemap
          - page: Webhook payload snippet
            path: ./pages/component-library/default-components/webhook-payload-snippet.mdx
            icon: fa-duotone fa-webhook
            slug: webhook-payload-snippet
          - page: Files
            path: ./pages/component-library/default-components/files.mdx
            icon: fa-duotone fa-folder-tree
            slug: files
          - page: Frame
            path: ./pages/component-library/default-components/frames.mdx
            icon: fa-duotone fa-window-maximize
            slug: frames
          - page: Icon
            path: ./pages/component-library/default-components/icons.mdx
            icon: fa-duotone fa-icons
            slug: icons
          - page: If
            path: ./pages/component-library/default-components/if.mdx
            icon: fa-duotone fa-filter
            slug: if
          - page: Indent
            path: ./pages/component-library/default-components/indent.mdx
            icon: fa-duotone fa-indent
            slug: indent
          - page: Parameter field
            path: ./pages/component-library/default-components/parameter-fields.mdx
            icon: fa-duotone fa-list
            slug: parameter-fields
          - page: Runnable endpoint
            path: ./pages/component-library/default-components/runnable-endpoint.mdx
            icon: fa-duotone fa-play-circle
          - page: Schema
            path: ./pages/component-library/default-components/schema.mdx
            icon: fa-duotone fa-brackets-curly
          - page: Schema snippet
            path: ./pages/component-library/default-components/schema-snippet.mdx
            icon: fa-duotone fa-file-code
            slug: schema-snippet
            hidden: true
          - page: Step
            path: ./pages/component-library/default-components/steps.mdx
            icon: fa-duotone fa-list-ol
            slug: steps
          - page: Table
            path: ./pages/component-library/default-components/tables.mdx
            icon: fa-duotone fa-table
            slug: tables
          - page: Tab
            path: ./pages/component-library/default-components/tabs.mdx
            icon: fa-duotone fa-folder-open
            slug: tabs
          - page: Tooltip
            path: ./pages/component-library/default-components/tooltips.mdx
            icon: fa-duotone fa-comment
            slug: tooltips
          - page: Versions
            path: ./pages/component-library/default-components/versions.mdx
            icon: fa-duotone fa-code-branch
            slug: versions
      - page: Fern Editor
        path: ./pages/component-library/writing-content/visual-editor.mdx
        slug: fern-editor
      - page: Reusable snippets
        path: ./pages/component-library/custom-components/reusable-markdown.mdx
      - page: Component demos
        hidden: true
        path: ./pages/component-library/demo.mdx
        slug: demo
  - section: AI features
    contents:
      - page: Overview
        path: ./pages/ai/overview.mdx
      - page: Fern Writer
        path: ./pages/ai/writer.mdx
      - page: AI-generated examples
        path: ./pages/ai/ai-examples.mdx
        slug: ai-examples
      - page: llms.txt
        path: ./pages/ai/llms-txt.mdx
        slug: llms-txt
      - section: Ask Fern
        slug: ask-fern
        contents:
          - page: Overview
            path: ./pages/ask-fern/what-is-ask-fern.mdx
            slug: overview
          - page: Setup
            path: ./pages/ask-fern/setup.mdx
          - page: Features
            path: ./pages/ask-fern/features.mdx
          - page: Guidance
            path: ./pages/ask-fern/guidance.mdx
          - page: Additional content sources
            path: ./pages/ask-fern/content-sources.mdx
            slug: content-sources
          - page: Slack app
            path: ./pages/ask-fern/slack-app.mdx
            slug: slack-app
          - page: Discord bot
            path: ./pages/ask-fern/discord-bot.mdx
            slug: discord-bot
          - api: API reference
            api-name: fai
            paginated: true
            collapsed: true
            audiences:
              - customers
            layout:
              - page: Overview
                path: ./pages/ask-fern/api-get-started.mdx
              - section: Slack Scribe
                referenced-packages:
                  - slackScribe
                hidden: true
                contents: []
  - section: Preview & publish
    collapsed: true
    contents:
      - page: Preview changes
        path: ./pages/getting-started/preview-changes-locally.mdx
      - page: Publishing your docs
        path: ./pages/getting-started/publishing-your-docs.mdx
      - page: Setting up your domain
        path: ./pages/getting-started/setting-up-your-domain.mdx
  - section: Customization
    collapsed: true
    contents:
      - page: Announcement banner
        path: ./pages/navigation/announcement-banner.mdx
      - page: Embedded mode
        path: ./pages/customization/embedded-mode.mdx
      - page: Hiding content
        path: ./pages/navigation/hiding-content.mdx
      - page: Search
        path: ./pages/customization/search.mdx
      - page: User feedback
        path: ./pages/customization/user-feedback.mdx
      - page: Custom CSS & JS
        path: ./pages/component-library/custom-components/custom-css-js.mdx
      - page: CSS selectors reference
        path: ./pages/component-library/custom-components/css-selectors.mdx
      - page: Custom React components
        path: ./pages/component-library/custom-components/custom-react-components.mdx
      - page: Header and footer
        path: ./pages/customization/custom-header-footer.mdx
  - section: Accessibility
    collapsed: true
    contents:
      - page: Overview
        path: ./pages/accessibility/overview.mdx
      - page: Keyboard shortcuts
        path: ./pages/accessibility/keyboard-shortcuts.mdx
  - section: API References
    collapsed: true
    contents:
      - section: Generation
        skip-slug: true
        contents:
          - page: REST API Reference
            path: ./pages/api-references/generate-api-ref.mdx
            slug: generate-api-ref
          - page: Webhook Reference
            path: ./pages/api-references/generate-webhook-ref.mdx
            slug: generate-webhook-ref
          - page: WebSocket Reference
            path: ./pages/api-references/generate-websocket-ref.mdx
            slug: generate-websocket-ref
          - page: OpenRPC Reference
            path: ./pages/api-references/generate-openrpc-ref.mdx
            slug: generate-openrpc-ref
          - page: gRPC Reference
            path: ./pages/api-references/generate-grpc-ref.mdx
            slug: generate-grpc-ref
          - page: GraphQL Reference
            path: ./pages/api-references/generate-graphql-ref.mdx
            slug: generate-graphql-ref
          - page: Library Docs
            path: ./pages/api-references/library-docs.mdx
            slug: library-docs
      - section: Customization
        skip-slug: true
        contents:
          - page: Customize API Reference layout
            path: ./pages/api-references/customize-api-ref.mdx
          - page: Audiences
            path: ./pages/api-references/audiences.mdx
          - page: Write Markdown in API Reference
            path: ./pages/api-references/api-ref-content.mdx
      - section: Code exploration
        skip-slug: true
        contents:
          - page: SDK snippets
            path: ./pages/api-references/sdk-snippets.mdx
          - page: HTTP snippets
            path: ./pages/api-references/http-snippets.mdx
          - page: API Explorer
            path: ./pages/api-references/api-explorer.mdx
            slug: api-explorer
  - section: SEO & GEO
    slug: seo
    collapsed: true
    contents:
      - page: Overview
        path: ./pages/seo/overview.mdx
      - page: Setting SEO metadata
        path: ./pages/seo/metadata.mdx
      - page: Configuring slugs
        path: ./pages/seo/configuring-slugs.mdx
      - page: Redirects
        path: ./pages/seo/redirects.mdx
  - section: Authentication
    collapsed: true
    contents:
      - page: Overview
        path: ./pages/authentication/overview.mdx
      - section: Setup
        slug: setup
        contents:
          - page: Password protection
            path: ./pages/authentication/password.mdx
          - page: SSO
            path: ./pages/authentication/sso.mdx
          - page: JWT
            path: ./pages/authentication/jwt-setup.mdx
            slug: jwt
          - page: OAuth
            path: ./pages/authentication/oauth-setup.mdx
            slug: oauth
      - section: Features
        slug: features
        contents:
          - page: Role-based access control (RBAC)
            path: ./pages/authentication/rbac.mdx
            slug: rbac
          - page: API key injection
            path: ./pages/authentication/api-key-injection.mdx
  - section: Security
    collapsed: true
    contents:
      - page: Overview
        path: ./pages/security/overview.mdx
  -  section: Self-hosted
     collapsed: true
     contents:
      - page: Overview
        path: ./pages/enterprise/self-hosted.mdx
      - page: Set up self-hosted documentation
        path: ./pages/enterprise/self-hosted-set-up.mdx
        slug: set-up
      - page: Authentication
        path: ./pages/enterprise/self-hosted-authentication.mdx
        slug: authentication
      - page: Health check endpoints
        path: ./pages/enterprise/health-check-endpoints.mdx
  - section: Analytics & integrations
    slug: integrations
    collapsed: true
    contents:
      - page: Overview
        path: ./pages/integrations/overview.mdx
      - page: Intercom
        path: ./pages/integrations/support/intercom.mdx
        slug: support/intercom
      - page: Google
        path: ./pages/integrations/analytics/google.mdx
        slug: analytics/google
      - page: PostHog
        path: ./pages/integrations/analytics/posthog.mdx
        slug: analytics/posthog
      - page: Fullstory
        path: ./pages/integrations/analytics/fullstory.mdx
        slug: analytics/fullstory
      - page: Segment
        path: ./pages/integrations/analytics/segment.mdx
        slug: analytics/segment
      - page: Mixpanel
        path: ./pages/integrations/analytics/mixpanel.mdx
        slug: analytics/mixpanel
      - page: Postman
        path: ./pages/integrations/postman.mdx
      - page: LaunchDarkly feature flags
        path: ./pages/integrations/feature-flags.mdx
        hidden: true
  - section: Developer tools
    collapsed: true
    contents:
      - page: Orchestrate GitHub releases
        path: ./pages/developer-tools/orchestrate-docs-releases.mdx
      - page: Auto-update last updated dates
        path: ./pages/developer-tools/auto-update-last-updated.mdx
      - page: Cursor
        path: ./pages/developer-tools/cursor.mdx
      - page: GitLab
        path: ./pages/developer-tools/gitlab.mdx
      - page: Vale
        path: ./pages/developer-tools/vale.mdx  
      - page: View Markdown
        path: ./pages/developer-tools/view-markdown.mdx
  - section: Resources
    collapsed: true
    hidden: true
    contents:
      - page: Stainless vs. Fern
        path: ./pages/resources/stainless-comparison.mdx
        slug: stainless-comparison
  - api: Public API
    paginated: false
    api-name: mcp-tools
    slug: fern-api-reference
  - api: Scribe API
    api-name: fai
    audiences:
      - customers
    flattened: true
    layout:
      - analytics:
          hidden: true
      - chat:
          hidden: true
      - code:
          hidden: true
      - conversation:
          hidden: true
      - discord:
          hidden: true
      - document:
          hidden: true
      - feedback:
          hidden: true
      - guidance:
          hidden: true
      - health:
          hidden: true
      - index:
          hidden: true
      - mcp:
          hidden: true
      - query:
          hidden: true
      - reindexing:
          hidden: true
      - sdks:
          hidden: true
      - settings:
          hidden: true
      - slackAskFern:
          hidden: true
      - section: "Fern Writer API"
        referenced-packages:
          - slackScribe
        contents: []
      - sources:
          hidden: true
      - website:
          hidden: true
    # must be included to use the schema component
  - api: API reference
    api-name: docs-yml