sidebars.js

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  docs: [
    {
      type: "doc",
      // If you change this make sure to update
      // src/theme/DocSidebar/Desktop/index.js
      // home link
      id: "home",
      label: "Home",
      className: "convex-sidebar-home",
    },
    {
      type: "html",
      value: '<hr class="convex-menu-divider" />',
      defaultStyle: false,
    },
    {
      type: "html",
      value: '<div class="convex-menu-header">Get Started</div>',
      defaultStyle: false,
    },
    {
      type: "category",
      label: "Tutorial",
      link: { type: "doc", id: "tutorial/index" },
      items: [{ type: "autogenerated", dirName: "tutorial" }],
      className: "convex-sidebar-tutorial",
    },
    {
      type: "category",
      label: "Quickstarts",
      link: { type: "doc", id: "quickstarts" },
      items: [{ type: "autogenerated", dirName: "quickstart" }],
      className: "convex-sidebar-quickstart",
    },
    {
      type: "doc",
      id: "zen",
      label: "Zen of Convex",
      className: "convex-sidebar-zen",
    },
    {
      type: "html",
      value: '<hr class="convex-menu-divider" />',
      defaultStyle: false,
    },
    {
      type: "html",
      value: '<div class="convex-menu-header">Platform</div>',
      defaultStyle: false,
    },
    {
      type: "category",
      label: "Functions",
      link: { type: "doc", id: "functions" },
      items: [{ type: "autogenerated", dirName: "functions" }],
      className: "convex-sidebar-functions",
    },
    {
      type: "category",
      label: "Database",
      link: { type: "doc", id: "database" },
      items: [{ type: "autogenerated", dirName: "database" }],
      className: "convex-sidebar-database",
    },
    {
      type: "doc",
      id: "realtime",
      className: "convex-sidebar-realtime",
    },
    {
      type: "category",
      label: "Authentication",
      link: { type: "doc", id: "auth" },
      items: [{ type: "autogenerated", dirName: "auth" }],
      className: "convex-sidebar-auth",
    },
    {
      type: "category",
      label: "Scheduling",
      link: { type: "doc", id: "scheduling" },
      items: [{ type: "autogenerated", dirName: "scheduling" }],
      className: "convex-sidebar-scheduling",
    },
    {
      type: "category",
      label: "File Storage",
      link: { type: "doc", id: "file-storage" },
      items: [{ type: "autogenerated", dirName: "file-storage" }],
      className: "convex-sidebar-file-storage",
    },
    {
      type: "category",
      label: "AI & Search",
      link: { type: "doc", id: "search" },
      items: [{ type: "autogenerated", dirName: "search" }],
      className: "convex-sidebar-search",
    },
    {
      type: "category",
      label: "Components",
      link: { type: "doc", id: "components" },
      items: [{ type: "autogenerated", dirName: "components" }],
      className: "convex-sidebar-components",
    },
    {
      type: "category",
      label: "Testing",
      link: { type: "doc", id: "testing" },
      items: [{ type: "autogenerated", dirName: "testing" }],
      className: "convex-sidebar-testing",
    },
    {
      type: "category",
      label: "Production",
      link: { type: "doc", id: "production" },
      items: [{ type: "autogenerated", dirName: "production" }],
      className: "convex-sidebar-production",
    },
    {
      type: "doc",
      id: "open-source",
      className: "convex-sidebar-open-source",
    },
    {
      type: "html",
      value: '<hr class="convex-menu-divider" />',
      defaultStyle: false,
    },
    {
      type: "html",
      value: '<div class="convex-menu-header">Client Libraries</div>',
      defaultStyle: false,
    },
    {
      type: "category",
      label: "React",
      link: { type: "doc", id: "client/react" },
      items: [{ type: "autogenerated", dirName: "client/react" }],
      className: "convex-sidebar-react",
    },
    {
      type: "doc",
      id: "client/tanstack-query",
      label: "React Query",
      className: "convex-sidebar-tanstack",
    },
    {
      type: "doc",
      id: "client/react-native",
      label: "React Native",
      className: "convex-sidebar-react-native",
    },
    {
      type: "category",
      label: "JavaScript",
      link: { type: "doc", id: "client/javascript" },
      items: [{ type: "autogenerated", dirName: "client/javascript" }],
      className: "convex-sidebar-javascript",
    },
    {
      type: "doc",
      id: "client/vue",
      label: "Vue",
      className: "convex-sidebar-vue",
    },
    {
      type: "doc",
      id: "client/svelte",
      label: "Svelte",
      className: "convex-sidebar-svelte",
    },
    {
      type: "doc",
      id: "client/python",
      label: "Python",
      className: "convex-sidebar-python",
    },
    {
      type: "category",
      label: "Swift",
      link: { type: "doc", id: "client/swift" },
      items: [{ type: "autogenerated", dirName: "client/swift" }],
      className: "convex-sidebar-swift",
    },
    {
      type: "category",
      label: "Android Kotlin",
      link: { type: "doc", id: "client/android" },
      items: [{ type: "autogenerated", dirName: "client/android" }],
      className: "convex-sidebar-android",
    },
    {
      type: "doc",
      id: "client/rust",
      label: "Rust",
      className: "convex-sidebar-rust",
    },
    {
      type: "doc",
      id: "client/open-api",
      label: "Open API",
      className: "convex-sidebar-open-api",
    },
    {
      type: "html",
      value: '<hr class="convex-menu-divider" />',
      defaultStyle: false,
    },
    {
      type: "html",
      value: '<div class="convex-menu-header">Tools</div>',
      defaultStyle: false,
    },
    {
      type: "category",
      label: "Dashboard",
      className: "convex-sidebar-dashboard",
      items: [{ type: "autogenerated", dirName: "dashboard" }],
      link: { type: "doc", id: "dashboard" },
    },
    {
      type: "doc",
      id: "cli",
      label: "CLI",
      className: "convex-sidebar-cli",
    },
    {
      type: "html",
      value: '<hr class="convex-menu-divider" />',
      defaultStyle: false,
    },
    {
      type: "html",
      value: '<div class="convex-menu-header">API Reference</div>',
      defaultStyle: false,
    },
    {
      type: "category",
      label: "Convex API",
      collapsible: true,
      link: { type: "doc", id: "api/index" },
      items: [{ type: "autogenerated", dirName: "api" }],
      className: "convex-sidebar-convex-api",
    },
    {
      type: "category",
      label: "Generated Code",
      collapsible: true,
      link: { type: "doc", id: "generated-api/index" },
      items: [{ type: "autogenerated", dirName: "generated-api" }],
      className: "convex-sidebar-generated-code",
    },
    {
      type: "doc",
      id: "http-api/index",
      label: "HTTP API",
      className: "convex-sidebar-http-api",
    },
    {
      type: "doc",
      id: "error",
      label: "Errors",
      className: "convex-sidebar-http-api",
    },
  ],
};

module.exports = sidebars;