Implementation:Dagster io Dagster Sidebars Configuration

Knowledge Sources	Dagster_io_Dagster Docusaurus Sidebars
Domains	Documentation, Site_Navigation
Last Updated	2026-02-10 12:30 GMT

Overview

Concrete tool for defining the hierarchical sidebar navigation structure of the Dagster documentation site built with Docusaurus.

Description

The sidebars.ts file is the central navigation configuration for the Dagster documentation site at docs.dagster.io. It exports a SidebarsConfig object that defines multiple sidebar sections: docs (main guides), examples, deployment, migration, integrations, and api. Each section uses a combination of explicit category definitions and Docusaurus autogenerated dirName patterns to automatically discover and include documentation pages within a directory.

Usage

Modify this file when adding new top-level documentation categories, rearranging the navigation hierarchy, or adding external links (such as Dagster University or customer case studies) to the sidebar. This is the single source of truth for how pages are organized in the left navigation panel of the docs site.

Code Reference

Source Location

• Repository: Dagster_io_Dagster
• File: docs/sidebars.ts
• Lines: 1-374

Signature

import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

const sidebars: SidebarsConfig = {
  docs: [
    // Getting Started, Tutorial, Build, Automate, Operate, Log & debug, Observe, Test, Labs, About
  ],
  examples: [
    // Full pipeline examples, Mini examples, Reference architectures
  ],
  deployment: [
    // Dagster+ deployment, OSS deployment, Execution, Troubleshooting
  ],
  migration: [
    // Migration guides
  ],
  integrations: [
    // Guides, Libraries
  ],
  api: [
    // Overview, CLI reference, Dagster core SDK, REST APIs, GraphQL API
  ],
};

export default sidebars;

Import

// This file is consumed by Docusaurus automatically via docusaurus.config.ts
// No manual import is needed; Docusaurus loads it as the sidebar configuration.

I/O Contract

Inputs

Name	Type	Required	Description
SidebarsConfig type	@docusaurus/plugin-content-docs	Yes	Type definition constraining the sidebar structure
dirName patterns	string	Yes	Directory names used by autogenerated items to discover pages (e.g., guides/build, deployment/dagster-plus)

Outputs

Name	Type	Description
sidebars	SidebarsConfig	Exported object consumed by Docusaurus to render sidebar navigation

Usage Examples

Adding a New Top-Level Category

// In sidebars.ts, add a new sidebar section:
const sidebars: SidebarsConfig = {
  // ... existing sections ...
  newSection: [
    {
      type: 'category',
      label: 'New Section',
      collapsed: false,
      link: {type: 'doc', id: 'new-section/index'},
      items: [
        {
          type: 'autogenerated',
          dirName: 'new-section',
        },
      ],
    },
  ],
};

Adding an External Link

// Inside any category's items array:
{
  type: 'link',
  label: 'External Resource',
  href: 'https://example.com/resource',
}

Related Pages

• Principle:Dagster_io_Dagster_Documentation_Site_Navigation