docs/sidebars.ts at main · 0xMiden/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";

/**
 * Multi-sidebar configuration for Builder and Core Concepts sections
 *
 * - builderSidebar: Usage-focused docs (tutorials, guides, reference)
 *   Canonical source: docs/builder/ (get-started, smart-contracts, etc.)
 *   Ingested content: docs/builder/tutorials/, docs/builder/client/
 *
 * - coreConceptsSidebar: Architecture/internals (protocol, VM, proving)
 *   Canonical source: Landing page in docs/core-concepts/index.md
 *   Ingested content: docs/core-concepts/protocol/, miden-vm/, compiler/, node/
 *
 * ARCHITECTURE NOTE:
 * External docs are ingested at build time via deploy-docs.yml into:
 *   - Core Concepts docs → docs/core-concepts/*
 *   - Builder docs → docs/builder/tutorials/, docs/builder/tools/client/
 * These paths are cleaned and re-synced on each build from source repos.
 */
const sidebars: SidebarsConfig = {
  builderSidebar: [
    // ── GETTING STARTED
    {
      type: "html",
      value: '<span class="sidebar-section">Getting Started</span>',
    },
    { type: "doc", id: "builder/index" },
    {
      type: "category",
      label: "Get Started",
      link: { type: "doc", id: "builder/get-started/index" },
      items: [{ type: "autogenerated", dirName: "builder/get-started" }],
    },

    // ── BUILD
    {
      type: "html",
      value: '<span class="sidebar-section">Build</span>',
    },
    {
      type: "category",
      label: "Smart Contracts",
      link: { type: "doc", id: "builder/smart-contracts/index" },
      items: [{ type: "autogenerated", dirName: "builder/smart-contracts" }],
    },
    {
      type: "category",
      label: "Tutorials",
      link: { type: "doc", id: "builder/tutorials/rust-compiler/index" },
      items: [{ type: "autogenerated", dirName: "builder/tutorials" }],
    },
    {
      type: "category",
      label: "Guides",
      items: [{ type: "autogenerated", dirName: "builder/guides" }],
    },
    {
      type: "category",
      label: "Tools",
      link: { type: "doc", id: "builder/tools/index" },
      items: [{ type: "autogenerated", dirName: "builder/tools" }],
    },

    // ── SOLUTIONS
    {
      type: "html",
      value: '<span class="sidebar-section">Solutions</span>',
    },
    {
      type: "category",
      label: "Guardian",
      link: { type: "doc", id: "builder/miden-guardian/index" },
      items: [{ type: "autogenerated", dirName: "builder/miden-guardian" }],
    },
    {
      type: "category",
      label: "Private Multisig",
      link: { type: "doc", id: "builder/private-multisig/index" },
      items: [
        { type: "autogenerated", dirName: "builder/private-multisig" },
      ],
    },

    // ── REFERENCE
    {
      type: "html",
      value: '<span class="sidebar-section">Reference</span>',
    },
    {
      type: "category",
      label: "Migration",
      link: { type: "doc", id: "builder/migration/index" },
      items: [
        "builder/migration/imports-dependencies",
        "builder/migration/hashing-stack",
        "builder/migration/account-changes",
        "builder/migration/note-changes",
        "builder/migration/asset-vault-faucet",
        "builder/migration/transaction-changes",
        "builder/migration/client-changes",
        "builder/migration/masm-changes",
        "builder/migration/vm-assembler",
      ],
    },
    { type: "doc", id: "builder/glossary" },
  ],

  // Core Concepts: landing page + ingested external content
  // Note: External docs are ingested during CI/CD build via deploy-docs.yml
  // For local dev, only the landing page exists; categories appear when content is ingested
  coreConceptsSidebar: [{ type: "autogenerated", dirName: "core-concepts" }],
};

export default sidebars;