sidebars.js

/**
 * 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.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  sidebar: [
    {
      type: 'doc',
      id: 'index',
      label: 'Noir',
    },
    {
      type: 'category',
      label: 'Getting Started',
      items: [{ type: 'autogenerated', dirName: 'getting_started' }],
    },
    {
      type: 'category',
      label: 'Examples',
      items: [{ type: 'autogenerated', dirName: 'examples' }],
    },
    {
      type: 'category',
      label: 'Nargo',
      items: [{ type: 'autogenerated', dirName: 'nargo' }],
    },
    {
      type: 'category',
      label: 'Language Concepts',
      items: [
        {
          type: 'category',
          label: 'Data Types',
          link: {
            type: 'doc',
            id: 'language_concepts/data_types',
          },
          items: [
            {
              type: 'autogenerated',
              dirName: 'language_concepts/data_types',
            },
          ],
        },
        'language_concepts/functions',
        'language_concepts/control_flow',
        'language_concepts/ops',
        'language_concepts/assert',
        'language_concepts/unconstrained',
        'language_concepts/generics',
        'language_concepts/mutability',
        'language_concepts/lambdas',
        'language_concepts/comments',
        'language_concepts/distinct',
        'language_concepts/shadowing',
      ],
    },
    {
      type: 'category',
      label: 'Noir Standard Library',
      items: [
        {
          type: 'category',
          label: 'Cryptographic Primitives',
          link: {
            type: 'doc',
            id: 'standard_library/cryptographic_primitives',
          },
          items: [
            {
              type: 'autogenerated',
              dirName: 'standard_library/cryptographic_primitives',
            },
          ],
        },
        'standard_library/recursion',
        'standard_library/logging',
        'standard_library/merkle_trees',
        'standard_library/zeroed',
        'standard_library/black_box_fns',
        'standard_library/options',
      ],
    },
    {
      type: 'category',
      label: 'Modules, Packages and Crates',
      items: [{ type: 'autogenerated', dirName: 'modules_packages_crates' }],
    },
    {
      type: 'category',
      label: 'Noir JS',
      link: {
        type: 'doc',
        id: 'noir_js/noir_js',
      },
      items: [
        {
          type: 'category',
          label: 'Reference',
          items: [
            {
              type: 'autogenerated',
              dirName: 'noir_js/reference',
            },
          ],
        },
        {
          type: 'category',
          label: 'Guides',
          items: [
            {
              type: 'autogenerated',
              dirName: 'noir_js/getting_started',
            },
          ],
        },
      ],
    },
    {
      type: 'doc',
      id: 'migration_notes',
      label: 'Migration notes',
    },
  ],
};

module.exports = sidebars;