Implementation:Deepset ai Haystack Sidebars Navigation Config

Knowledge Sources	Deepset_ai_Haystack Docusaurus Sidebars
Domains	Documentation, Navigation
Last Updated	2026-02-11 20:00 GMT

Overview

Concrete configuration file that defines the full sidebar navigation tree for the Haystack documentation website built with Docusaurus.

Description

The sidebars.js file exports a deeply nested JavaScript object that defines the sidebar navigation structure for the main Haystack narrative documentation. It organizes all documentation pages into a hierarchical category tree covering Introduction, Overview (installation, getting started, FAQ, migration), Haystack Concepts (Agents, Components, Pipelines, Data Classes, Document Stores), Document Stores (InMemory, Astra, Elasticsearch, Pinecone, etc.), Pipeline Components (Agents, Audio, Builders, Classifiers, Connectors, Converters, Embedders, Evaluators, Extractors, Fetchers, Generators, Joiners, Preprocessors, Rankers, Readers, Retrievers, Routers, Samplers, Tools, Validators, Websearch, Writers), Tools, Optimization, and Development sections. It uses Docusaurus sidebar item types including doc references, category groups with optional link targets, and external link items for integration pages hosted outside the main docs.

Usage

This file is consumed by the Docusaurus build system when generating the documentation site. It determines the ordering and grouping of all pages in the left sidebar. Modify this file when adding new documentation pages, reorganizing the navigation hierarchy, or linking to new external integration docs.

Code Reference

Source Location

• Repository: Deepset_ai_Haystack
• File: docs-website/sidebars.js
• Lines: 1-682

Signature

export default {
  docs: [
    {
      type: 'doc',
      id: 'intro',
      label: 'Introduction',
    },
    {
      type: 'category',
      label: 'Overview',
      items: [ /* ... */ ],
    },
    {
      type: 'category',
      label: 'Haystack Concepts',
      items: [ /* Agents, Components, Pipelines, Data Classes, Document Store, ... */ ],
    },
    {
      type: 'category',
      label: 'Document Stores',
      items: [ /* InMemory, Astra, Elasticsearch, ... */ ],
    },
    {
      type: 'category',
      label: 'Pipeline Components',
      items: [ /* Agents, Audio, Builders, Classifiers, Connectors, Converters, Embedders, Evaluators, Extractors, Fetchers, Generators, Joiners, Preprocessors, Rankers, Readers, Retrievers, Routers, Samplers, Tools, Validators, Websearch, Writers */ ],
    },
    {
      type: 'category',
      label: 'Tools',
      items: [ /* Tool, ComponentTool, PipelineTool, Toolset, MCPTool, MCPToolset */ ],
    },
    {
      type: 'category',
      label: 'Optimization',
      items: [ /* Evaluation, Advanced RAG Techniques */ ],
    },
    {
      type: 'category',
      label: 'Development',
      items: [ /* Logging, Tracing, GPU, Hayhooks, Deployment */ ],
    },
  ],
};

Import

// Consumed by Docusaurus via docusaurus.config.js
// sidebarPath: './sidebars.js'

I/O Contract

Inputs

Name	Type	Required	Description
(none)	—	—	This is a static configuration export with no runtime inputs

Outputs

Name	Type	Description
docs	Array<SidebarItem>	Nested array of Docusaurus sidebar items defining the full navigation tree

Usage Examples

Adding a New Documentation Page

// To add a new page under Pipeline Components > Generators:
{
  type: 'category',
  label: 'Generators',
  link: {
    type: 'doc',
    id: 'pipeline-components/generators'
  },
  items: [
    // ... existing items ...
    'pipeline-components/generators/newgenerator',  // Add new page reference
  ],
},

Adding an External Integration Link

// To add a link to an external integration page:
{
  type: 'link',
  label: 'NewDocumentStore',
  href: 'https://haystack.deepset.ai/integrations/new-document-store',
},

Related Pages

• Environment:Deepset_ai_Haystack_Python_Runtime_Environment