langchain/docs/sidebars.js

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @format
 */

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

module.exports = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  docs: [
    {
      type: "category",
      label: "Get started",
      collapsed: false,
      collapsible: false,
      items: [{ type: "autogenerated", dirName: "get_started" }, "security"],
      link: {
        type: "generated-index",
        description: "Get started with LangChain",
        slug: "get_started",
      },
    },
    {
      type: "category",
      label: "LangChain Expression Language",
      collapsed: false,
      items: [{ type: "autogenerated", dirName: "expression_language" }],
      link: {
        type: "doc",
        id: "expression_language/index",
      },
    },
    {
      type: "category",
      label: "Modules",
      collapsed: false,
      items: [
        {
          type: "category",
          label: "Model I/O",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "modules/model_io" }],
          link: { type: "doc", id: "modules/model_io/index" },
        },
        {
          type: "category",
          label: "Retrieval",
          collapsed: true,
          items: [
            { type: "autogenerated", dirName: "modules/data_connection" },
          ],
          link: { type: "doc", id: "modules/data_connection/index" },
        },
        {
          type: "category",
          label: "Agents",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "modules/agents" }],
          link: { type: "doc", id: "modules/agents/index" },
        },
        "modules/chains",
        {
          type: "category",
          label: "More",
          collapsed: true,
          items: [
            {
              type: "category",
              label: "Memory",
              collapsed: true,
              items: [{ type: "autogenerated", dirName: "modules/memory" }],
              link: { type: "doc", id: "modules/memory/index" },
            },
            {
              type: "category",
              label: "Callbacks",
              collapsed: true,
              items: [{ type: "autogenerated", dirName: "modules/callbacks" }],
              link: { type: "doc", id: "modules/callbacks/index" },
            },
          ],
        },
      ],
      link: {
        type: "doc",
        id: "modules/index",
      },
    },
    { type: "doc", id: "langserve", label: "LangServe" },
    {
      type: "category",
      label: "LangSmith",
      collapsed: true,
      items: [{ type: "autogenerated", dirName: "langsmith" }],
      link: {
        type: "doc",
        id: "langsmith/index",
      },
    },
    { type: "doc", id: "langgraph", label: "LangGraph" },
  ],
  integrations: [
    {
      type: "category",
      label: "Providers",
      collapsible: false,
      items: [
        { type: "autogenerated", dirName: "integrations/platforms" },
        {
          type: "category",
          label: "More",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/providers" }],
          link: { type: "generated-index", slug: "integrations/providers" },
        },
      ],
      link: {
        type: "doc",
        id: "integrations/platforms/index",
      },
    },
    {
      type: "category",
      label: "Components",
      collapsible: false,
      items: [
        {
          type: "category",
          label: "LLMs",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/llms" }],
          link: { type: "doc", id: "integrations/llms/index" },
        },
        {
          type: "category",
          label: "Chat models",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/chat" }],
          link: { type: "doc", id: "integrations/chat/index" },
        },
        {
          type: "category",
          label: "Embedding models",
          collapsed: true,
          items: [
            { type: "autogenerated", dirName: "integrations/text_embedding" },
          ],
          link: {
            type: "generated-index",
            slug: "integrations/text_embedding",
          },
        },
        {
          type: "category",
          label: "Document loaders",
          collapsed: true,
          items: [
            { type: "autogenerated", dirName: "integrations/document_loaders" },
          ],
          link: {
            type: "generated-index",
            slug: "integrations/document_loaders",
          },
        },
        {
          type: "category",
          label: "Document transformers",
          collapsed: true,
          items: [
            {
              type: "autogenerated",
              dirName: "integrations/document_transformers",
            },
          ],
          link: {
            type: "generated-index",
            slug: "integrations/document_transformers",
          },
        },
        {
          type: "category",
          label: "Vector stores",
          collapsed: true,
          items: [
            { type: "autogenerated", dirName: "integrations/vectorstores" },
          ],
          link: { type: "generated-index", slug: "integrations/vectorstores" },
        },
        {
          type: "category",
          label: "Retrievers",
          collapsed: true,
          items: [
            { type: "autogenerated", dirName: "integrations/retrievers" },
          ],
          link: { type: "generated-index", slug: "integrations/retrievers" },
        },
        {
          type: "category",
          label: "Tools",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/tools" }],
          link: { type: "generated-index", slug: "integrations/tools" },
        },
        {
          type: "category",
          label: "Toolkits",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/toolkits" }],
          link: { type: "generated-index", slug: "integrations/toolkits" },
        },
        {
          type: "category",
          label: "Memory",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/memory" }],
          link: { type: "generated-index", slug: "integrations/memory" },
        },
        {
          type: "category",
          label: "Callbacks",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/callbacks" }],
          link: { type: "generated-index", slug: "integrations/callbacks" },
        },
        {
          type: "category",
          label: "Chat loaders",
          collapsed: true,
          items: [
            { type: "autogenerated", dirName: "integrations/chat_loaders" },
          ],
          link: { type: "generated-index", slug: "integrations/chat_loaders" },
        },
        {
          type: "category",
          label: "Adapters",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/adapters" }],
          link: { type: "generated-index", slug: "integrations/adapters" },
        },
        {
          type: "category",
          label: "Stores",
          collapsed: true,
          items: [{ type: "autogenerated", dirName: "integrations/stores" }],
          link: { type: "doc", id: "integrations/stores/index" },
        },
      ],
      link: {
        type: "generated-index",
        slug: "integrations/components",
      },
    },
  ],
  use_cases: [
    {
      type: "category",
      label: "Use cases",
      items: [{ type: "autogenerated", dirName: "use_cases" }],
      link: { type: "generated-index", slug: "use_cases" },
    },
  ],
  guides: [{ type: "autogenerated", dirName: "guides" }],
  templates: [
    {
      type: "category",
      label: "Templates",
      items: [{ type: "autogenerated", dirName: "templates" }],
      link: { type: "doc", id: "templates/index" },
    },
  ],
  changelog: [
    {
      type: "category",
      label: "Changelog",
      items: [{ type: "autogenerated", dirName: "changelog" }],
      link: { type: "generated-index", slug: "changelog" },
    },
  ],
  contributing: [{ type: "autogenerated", dirName: "contributing" }],
};