v10/site/src/docs.config.ts

import type { Sidebar } from '@/types/docs';

export const sidebar: Sidebar = [
  {
    sidebarLabel: 'Site development',
    devOnly: true,
    contents: [
      {
        slug: 'how-to/write-guides',
        sidebarLabel: 'Writing guides',
        devOnly: true,
      },
      {
        slug: 'reference/write-references',
        sidebarLabel: 'Writing references',
        devOnly: true,
      },
    ],
  },
  {
    sidebarLabel: 'Contributing',
    devOnly: true,
    contents: [{ slug: 'how-to/i18n-add-built-in-locale', sidebarLabel: 'Add a built-in locale' }],
  },
  {
    sidebarLabel: 'Getting started',
    // May change when we revisit this section's boundary with Concepts (#1105)
    llmsDescription: 'Installation, project setup, and introductory guides.',
    contents: [
      { slug: 'how-to/installation' },
      { slug: 'concepts/why-videojs' },
      { slug: 'concepts/overview' },
      { slug: 'how-to/build-with-ai' },
      { slug: 'concepts/v10-roadmap', sidebarLabel: 'Roadmap' },
      { href: '/changelog', sidebarLabel: 'Changelog' },
      { slug: 'concepts/browser-support' },
    ],
  },
  {
    sidebarLabel: 'Concepts',
    llmsDescription:
      'Understanding-oriented pages that explain how and why things work. Read these to build a mental model of the library.',
    contents: [
      { slug: 'concepts/features' },
      { slug: 'concepts/skins' },
      { slug: 'concepts/presets' },
      { slug: 'concepts/ui-components' },
      { slug: 'concepts/accessibility' },
      { slug: 'concepts/cast', sidebarLabel: 'Google Cast' },
      { slug: 'concepts/i18n', sidebarLabel: 'Internationalization' },
    ],
  },
  {
    sidebarLabel: 'How to',
    llmsDescription:
      'Task-oriented guides with step-by-step instructions to achieve a specific outcome by applying one or more concepts. Each guide may assume you already understand the relevant concepts.',
    contents: [
      { slug: 'how-to/customize-skins' },
      { slug: 'how-to/build-your-own-component' },
      { slug: 'how-to/self-host-the-player', frameworks: ['html'] },
      {
        sidebarLabel: 'Internationalization',
        contents: [
          { slug: 'how-to/i18n-register-locale', sidebarLabel: 'Register a locale' },
          { slug: 'how-to/i18n-override-translations', sidebarLabel: 'Override translations' },
          { slug: 'how-to/i18n-switch-locale', sidebarLabel: 'Switch locale' },
          { slug: 'how-to/i18n-ssr', sidebarLabel: 'SSR with locale' },
        ],
      },
    ],
  },
  {
    sidebarLabel: 'Components',
    llmsDescription: 'API Reference for UI components for building media player interfaces.',
    contents: [
      { slug: 'reference/player-provider' },
      { slug: 'reference/player-container' },
      { slug: 'reference/i18n-provider' },
      // sorted alphabetically
      { slug: 'reference/airplay-button' },
      { slug: 'reference/audio-track-radio-group' },
      { slug: 'reference/buffering-indicator' },
      { slug: 'reference/captions-button' },
      { slug: 'reference/cast-button' },
      { slug: 'reference/controls' },
      { slug: 'reference/fullscreen-button' },
      { slug: 'reference/menu' },
      { slug: 'reference/mute-button' },
      { slug: 'reference/pip-button' },
      { slug: 'reference/play-button' },
      { slug: 'reference/playback-rate-button' },
      { slug: 'reference/popover' },
      { slug: 'reference/poster' },
      { slug: 'reference/quality-radio-group' },
      { slug: 'reference/seek-button' },
      { slug: 'reference/slider' },
      { slug: 'reference/thumbnail' },
      { slug: 'reference/time' },
      { slug: 'reference/time-slider' },
      { slug: 'reference/tooltip' },
      { slug: 'reference/volume-slider' },
    ],
  },
  {
    sidebarLabel: 'Media Elements',
    llmsDescription: 'API Reference for media elements that handle streaming protocols and media playback.',
    contents: [
      { slug: 'reference/background-video' },
      { slug: 'reference/dash-video' },
      { slug: 'reference/hlsjs-video' },
      { slug: 'reference/mux-audio' },
      { slug: 'reference/mux-video' },
      { slug: 'reference/native-hls-video' },
      { slug: 'reference/simple-hls-audio-only' },
      { slug: 'reference/simple-hls-video' },
    ],
  },
  {
    sidebarLabel: 'Hooks & Utilities',
    llmsDescription: 'API Reference for React hooks and utilities for player integration.',
    frameworks: ['react'],
    contents: [
      { slug: 'reference/create-player' },
      { slug: 'reference/create-i18n' },
      { slug: 'reference/use-translator' },
      { slug: 'reference/use-locale' },
      { slug: 'reference/use-player' },
      { slug: 'reference/use-media' },
      { slug: 'reference/use-store' },
      {
        sidebarLabel: 'Advanced',
        defaultOpen: false,
        contents: [
          { slug: 'reference/render-element' },
          { slug: 'reference/use-button' },
          { slug: 'reference/use-container-attach' },
          { slug: 'reference/use-media-attach' },
          { slug: 'reference/use-player-context' },
          { slug: 'reference/use-selector' },
          { slug: 'reference/use-snapshot' },
        ],
      },
    ],
  },
  {
    sidebarLabel: 'Controllers & Mixins',
    llmsDescription: 'API Reference for controllers and mixins for HTML custom element integration.',
    frameworks: ['html'],
    contents: [
      { slug: 'reference/html-create-player', sidebarLabel: 'createPlayer' },
      { slug: 'reference/media-i18n', sidebarLabel: 'media-i18n' },
      { slug: 'reference/media-text', sidebarLabel: 'media-text' },
      { slug: 'reference/player-controller' },
      {
        sidebarLabel: 'Advanced',
        defaultOpen: false,
        contents: [
          { slug: 'reference/container-mixin' },
          { slug: 'reference/media-attach-mixin' },
          { slug: 'reference/player-context' },
          { slug: 'reference/provider-mixin' },
          { slug: 'reference/snapshot-controller' },
          { slug: 'reference/store-controller' },
        ],
      },
    ],
  },
  {
    sidebarLabel: 'Features',
    llmsDescription: 'API reference for feature modules that provide player capabilities and state.',
    contents: [
      { slug: 'reference/create-selector' },
      { slug: 'reference/feature-buffer' },
      { slug: 'reference/feature-controls' },
      { slug: 'reference/feature-error' },
      { slug: 'reference/feature-fullscreen' },
      { slug: 'reference/feature-live' },
      { slug: 'reference/feature-orientation-lock' },
      { slug: 'reference/feature-pip', sidebarLabel: 'Picture-in-picture' },
      { slug: 'reference/feature-playback' },
      { slug: 'reference/feature-playback-rate' },
      { slug: 'reference/feature-quality' },
      { slug: 'reference/feature-audio-track' },
      { slug: 'reference/feature-remote-playback' },
      { slug: 'reference/feature-source' },
      { slug: 'reference/feature-stream-type' },
      { slug: 'reference/feature-text-tracks' },
      { slug: 'reference/feature-time' },
      { slug: 'reference/feature-volume' },
    ],
  },
  {
    sidebarLabel: 'Internationalization',
    llmsDescription: 'API reference for locale registration, translation helpers, and i18n types.',
    contents: [
      { slug: 'reference/register-i18n', sidebarLabel: 'registerI18n' },
      { slug: 'reference/get-i18n-translations', sidebarLabel: 'getI18nTranslations' },
      { slug: 'reference/has-registered-locale', sidebarLabel: 'hasRegisteredLocale' },
      { slug: 'reference/on-i18n-registry-change', sidebarLabel: 'onI18nRegistryChange' },
      { slug: 'reference/create-translator', sidebarLabel: 'createTranslator' },
      {
        sidebarLabel: 'Types',
        defaultOpen: false,
        contents: [
          { slug: 'reference/built-in-locale', sidebarLabel: 'BuiltInLocale' },
          { slug: 'reference/locale', sidebarLabel: 'Locale' },
          { slug: 'reference/translation-params', sidebarLabel: 'TranslationParams' },
          { slug: 'reference/translations', sidebarLabel: 'Translations' },
          { slug: 'reference/translator', sidebarLabel: 'Translator' },
        ],
      },
    ],
  },
];