docs: enable protocol specs for docs in dev mode (#11219)

`yarn dev` or `yarn dev:local` now show protocol specs, but `yarn build` or `yarn docs` does not. You can also enable via `SHOW_PROTOCOL_SPECS=1`. Moved protocol specs back to original folder.
AztecProtocol · Jan 14, 2025 · 10c8afe · 10c8afe
1 parent 93ade26
commit 10c8afe
Show file tree

Hide file tree

Showing 100 changed files with 235 additions and 1,606 deletions.
diff --git a/docs/docs/_protocol-specs/public-vm/gen/_instruction-set.mdx b/docs/docs/_protocol-specs/public-vm/gen/_instruction-set.mdx
diff --git a/...tocol-specs/addresses-and-keys/address.md → ...tocol-specs/addresses-and-keys/address.md b/...tocol-specs/addresses-and-keys/address.md → ...tocol-specs/addresses-and-keys/address.md
diff --git a/...esses-and-keys/diversified-and-stealth.md → ...esses-and-keys/diversified-and-stealth.md b/...esses-and-keys/diversified-and-stealth.md → ...esses-and-keys/diversified-and-stealth.md
diff --git a/...ple-usage/diversified-and-stealth-keys.md → ...ple-usage/diversified-and-stealth-keys.md b/...ple-usage/diversified-and-stealth-keys.md → ...ple-usage/diversified-and-stealth-keys.md
diff --git a/...and-keys/example-usage/encrypt-and-tag.md → ...and-keys/example-usage/encrypt-and-tag.md b/...and-keys/example-usage/encrypt-and-tag.md → ...and-keys/example-usage/encrypt-and-tag.md
diff --git a/...esses-and-keys/example-usage/nullifier.md → ...esses-and-keys/example-usage/nullifier.md b/...esses-and-keys/example-usage/nullifier.md → ...esses-and-keys/example-usage/nullifier.md
diff --git a/.../example-usage/tag-sequence-derivation.md → .../example-usage/tag-sequence-derivation.md b/.../example-usage/tag-sequence-derivation.md → .../example-usage/tag-sequence-derivation.md
diff --git a/...rotocol-specs/addresses-and-keys/index.md → ...rotocol-specs/addresses-and-keys/index.md b/...rotocol-specs/addresses-and-keys/index.md → ...rotocol-specs/addresses-and-keys/index.md
diff --git a/...s/addresses-and-keys/keys-requirements.md → ...s/addresses-and-keys/keys-requirements.md b/...s/addresses-and-keys/keys-requirements.md → ...s/addresses-and-keys/keys-requirements.md
diff --git a/...protocol-specs/addresses-and-keys/keys.md → ...protocol-specs/addresses-and-keys/keys.md b/...protocol-specs/addresses-and-keys/keys.md → ...protocol-specs/addresses-and-keys/keys.md
diff --git a/...l-specs/addresses-and-keys/precompiles.md → ...l-specs/addresses-and-keys/precompiles.md b/...l-specs/addresses-and-keys/precompiles.md → ...l-specs/addresses-and-keys/precompiles.md
diff --git a/docs/docs/_protocol-specs/bytecode/index.md → docs/docs/protocol-specs/bytecode/index.md b/docs/docs/_protocol-specs/bytecode/index.md → docs/docs/protocol-specs/bytecode/index.md
diff --git a/...cs/_protocol-specs/calls/batched-calls.md → ...ocs/protocol-specs/calls/batched-calls.md b/...cs/_protocol-specs/calls/batched-calls.md → ...ocs/protocol-specs/calls/batched-calls.md
diff --git a/...s/_protocol-specs/calls/enqueued-calls.md → ...cs/protocol-specs/calls/enqueued-calls.md b/...s/_protocol-specs/calls/enqueued-calls.md → ...cs/protocol-specs/calls/enqueued-calls.md
diff --git a/docs/docs/_protocol-specs/calls/index.md → docs/docs/protocol-specs/calls/index.md b/docs/docs/_protocol-specs/calls/index.md → docs/docs/protocol-specs/calls/index.md
diff --git a/...l-specs/calls/public-private-messaging.md → ...l-specs/calls/public-private-messaging.md b/...l-specs/calls/public-private-messaging.md → ...l-specs/calls/public-private-messaging.md
diff --git a/...ocs/_protocol-specs/calls/static-calls.md → ...docs/protocol-specs/calls/static-calls.md b/...ocs/_protocol-specs/calls/static-calls.md → ...docs/protocol-specs/calls/static-calls.md
diff --git a/.../docs/_protocol-specs/calls/sync-calls.md → docs/docs/protocol-specs/calls/sync-calls.md b/.../docs/_protocol-specs/calls/sync-calls.md → docs/docs/protocol-specs/calls/sync-calls.md
diff --git a/...otocol-specs/calls/unconstrained-calls.md → ...otocol-specs/calls/unconstrained-calls.md b/...otocol-specs/calls/unconstrained-calls.md → ...otocol-specs/calls/unconstrained-calls.md
diff --git a/...col-specs/circuits/high-level-topology.md → ...col-specs/circuits/high-level-topology.md b/...col-specs/circuits/high-level-topology.md → ...col-specs/circuits/high-level-topology.md
diff --git a/...otocol-specs/circuits/private-function.md → ...otocol-specs/circuits/private-function.md b/...otocol-specs/circuits/private-function.md → ...otocol-specs/circuits/private-function.md
diff --git a/...specs/circuits/private-kernel-initial.mdx → ...specs/circuits/private-kernel-initial.mdx b/...specs/circuits/private-kernel-initial.mdx → ...specs/circuits/private-kernel-initial.mdx
diff --git a/...l-specs/circuits/private-kernel-inner.mdx → ...l-specs/circuits/private-kernel-inner.mdx b/...l-specs/circuits/private-kernel-inner.mdx → ...l-specs/circuits/private-kernel-inner.mdx
diff --git a/...ol-specs/circuits/private-kernel-reset.md → ...ol-specs/circuits/private-kernel-reset.md b/...ol-specs/circuits/private-kernel-reset.md → ...ol-specs/circuits/private-kernel-reset.md
diff --git a/...col-specs/circuits/private-kernel-tail.md → ...col-specs/circuits/private-kernel-tail.md b/...col-specs/circuits/private-kernel-tail.md → ...col-specs/circuits/private-kernel-tail.md
diff --git a/...l-specs/circuits/public-kernel-initial.md → ...l-specs/circuits/public-kernel-initial.md b/...l-specs/circuits/public-kernel-initial.md → ...l-specs/circuits/public-kernel-initial.md
diff --git a/...col-specs/circuits/public-kernel-inner.md → ...col-specs/circuits/public-kernel-inner.md b/...col-specs/circuits/public-kernel-inner.md → ...col-specs/circuits/public-kernel-inner.md
diff --git a/...ocol-specs/circuits/public-kernel-tail.md → ...ocol-specs/circuits/public-kernel-tail.md b/...ocol-specs/circuits/public-kernel-tail.md → ...ocol-specs/circuits/public-kernel-tail.md
diff --git a/docs/docs/_protocol-specs/constants.md → docs/docs/protocol-specs/constants.md b/docs/docs/_protocol-specs/constants.md → docs/docs/protocol-specs/constants.md
diff --git a/...ocol-specs/contract-deployment/classes.md → ...ocol-specs/contract-deployment/classes.md b/...ocol-specs/contract-deployment/classes.md → ...ocol-specs/contract-deployment/classes.md
diff --git a/...otocol-specs/contract-deployment/index.md → ...otocol-specs/contract-deployment/index.md b/...otocol-specs/contract-deployment/index.md → ...otocol-specs/contract-deployment/index.md
diff --git a/...ol-specs/contract-deployment/instances.md → ...ol-specs/contract-deployment/instances.md b/...ol-specs/contract-deployment/instances.md → ...ol-specs/contract-deployment/instances.md
diff --git a/...col-specs/cryptography/hashing/hashing.md → ...col-specs/cryptography/hashing/hashing.md b/...col-specs/cryptography/hashing/hashing.md → ...col-specs/cryptography/hashing/hashing.md
diff --git a/...ol-specs/cryptography/hashing/pedersen.md → ...ol-specs/cryptography/hashing/pedersen.md b/...ol-specs/cryptography/hashing/pedersen.md → ...ol-specs/cryptography/hashing/pedersen.md
diff --git a/...l-specs/cryptography/hashing/poseidon2.md → ...l-specs/cryptography/hashing/poseidon2.md b/...l-specs/cryptography/hashing/poseidon2.md → ...l-specs/cryptography/hashing/poseidon2.md
diff --git a/...ocs/_protocol-specs/cryptography/index.md → ...docs/protocol-specs/cryptography/index.md b/...ocs/_protocol-specs/cryptography/index.md → ...docs/protocol-specs/cryptography/index.md
diff --git a/...otocol-specs/cryptography/merkle-trees.md → ...otocol-specs/cryptography/merkle-trees.md b/...otocol-specs/cryptography/merkle-trees.md → ...otocol-specs/cryptography/merkle-trees.md
diff --git a/...s/cryptography/proving-system/data-bus.md → ...s/cryptography/proving-system/data-bus.md b/...s/cryptography/proving-system/data-bus.md → ...s/cryptography/proving-system/data-bus.md
diff --git a/...s/cryptography/proving-system/overview.md → ...s/cryptography/proving-system/overview.md b/...s/cryptography/proving-system/overview.md → ...s/cryptography/proving-system/overview.md
diff --git a/...phy/proving-system/performance-targets.md → ...phy/proving-system/performance-targets.md b/...phy/proving-system/performance-targets.md → ...phy/proving-system/performance-targets.md
diff --git a/...ata-publication-and-availability/index.md → ...ata-publication-and-availability/index.md b/...ata-publication-and-availability/index.md → ...ata-publication-and-availability/index.md
diff --git a/...-publication-and-availability/overview.md → ...-publication-and-availability/overview.md b/...-publication-and-availability/overview.md → ...-publication-and-availability/overview.md
diff --git a/...cation-and-availability/published-data.md → ...cation-and-availability/published-data.md b/...cation-and-availability/published-data.md → ...cation-and-availability/published-data.md
diff --git a/...protocol-specs/decentralization/actors.md → ...protocol-specs/decentralization/actors.md b/...protocol-specs/decentralization/actors.md → ...protocol-specs/decentralization/actors.md
diff --git a/...pecs/decentralization/block-production.md → ...pecs/decentralization/block-production.md b/...pecs/decentralization/block-production.md → ...pecs/decentralization/block-production.md
diff --git a/...ocol-specs/decentralization/governance.md → ...ocol-specs/decentralization/governance.md b/...ocol-specs/decentralization/governance.md → ...ocol-specs/decentralization/governance.md
diff --git a/...col-specs/decentralization/p2p-network.md → ...col-specs/decentralization/p2p-network.md b/...col-specs/decentralization/p2p-network.md → ...col-specs/decentralization/p2p-network.md
diff --git a/..._protocol-specs/gas-and-fees/fee-juice.md → .../protocol-specs/gas-and-fees/fee-juice.md b/..._protocol-specs/gas-and-fees/fee-juice.md → .../protocol-specs/gas-and-fees/fee-juice.md
diff --git a/...otocol-specs/gas-and-fees/fee-schedule.md → ...otocol-specs/gas-and-fees/fee-schedule.md b/...otocol-specs/gas-and-fees/fee-schedule.md → ...otocol-specs/gas-and-fees/fee-schedule.md
diff --git a/...ocs/_protocol-specs/gas-and-fees/index.md → ...docs/protocol-specs/gas-and-fees/index.md b/...ocs/_protocol-specs/gas-and-fees/index.md → ...docs/protocol-specs/gas-and-fees/index.md
diff --git a/...col-specs/gas-and-fees/kernel-tracking.md → ...col-specs/gas-and-fees/kernel-tracking.md b/...col-specs/gas-and-fees/kernel-tracking.md → ...col-specs/gas-and-fees/kernel-tracking.md
diff --git a/...as-and-fees/published-gas-and-fee-data.md → ...as-and-fees/published-gas-and-fee-data.md b/...as-and-fees/published-gas-and-fee-data.md → ...as-and-fees/published-gas-and-fee-data.md
diff --git a/...s/gas-and-fees/specifying-gas-fee-info.md → ...s/gas-and-fees/specifying-gas-fee-info.md b/...s/gas-and-fees/specifying-gas-fee-info.md → ...s/gas-and-fees/specifying-gas-fee-info.md
diff --git a/...ecs/gas-and-fees/tx-setup-and-teardown.md → ...ecs/gas-and-fees/tx-setup-and-teardown.md b/...ecs/gas-and-fees/tx-setup-and-teardown.md → ...ecs/gas-and-fees/tx-setup-and-teardown.md
diff --git a/docs/docs/_protocol-specs/intro.md → docs/docs/protocol-specs/intro.md b/docs/docs/_protocol-specs/intro.md → docs/docs/protocol-specs/intro.md
diff --git a/...ocol-specs/l1-smart-contracts/frontier.md → ...ocol-specs/l1-smart-contracts/frontier.md b/...ocol-specs/l1-smart-contracts/frontier.md → ...ocol-specs/l1-smart-contracts/frontier.md
diff --git a/...rotocol-specs/l1-smart-contracts/index.md → ...rotocol-specs/l1-smart-contracts/index.md b/...rotocol-specs/l1-smart-contracts/index.md → ...rotocol-specs/l1-smart-contracts/index.md
diff --git a/docs/docs/_protocol-specs/logs/index.md → docs/docs/protocol-specs/logs/index.md b/docs/docs/_protocol-specs/logs/index.md → docs/docs/protocol-specs/logs/index.md
diff --git a/...col-specs/pre-compiled-contracts/index.md → ...col-specs/pre-compiled-contracts/index.md b/...col-specs/pre-compiled-contracts/index.md → ...col-specs/pre-compiled-contracts/index.md
diff --git a/...-specs/pre-compiled-contracts/registry.md → ...-specs/pre-compiled-contracts/registry.md b/...-specs/pre-compiled-contracts/registry.md → ...-specs/pre-compiled-contracts/registry.md
diff --git a/...l-specs/private-message-delivery/index.md → ...l-specs/private-message-delivery/index.md b/...l-specs/private-message-delivery/index.md → ...l-specs/private-message-delivery/index.md
diff --git a/...-message-delivery/private-msg-delivery.md → ...-message-delivery/private-msg-delivery.md b/...-message-delivery/private-msg-delivery.md → ...-message-delivery/private-msg-delivery.md
diff --git a/...-message-delivery/send-note-guidelines.md → ...-message-delivery/send-note-guidelines.md b/...-message-delivery/send-note-guidelines.md → ...-message-delivery/send-note-guidelines.md
diff --git a/...otocol-specs/public-vm/_nested-context.md → ...otocol-specs/public-vm/_nested-context.md b/...otocol-specs/public-vm/_nested-context.md → ...otocol-specs/public-vm/_nested-context.md
diff --git a/docs/docs/_protocol-specs/public-vm/alu.md → docs/docs/protocol-specs/public-vm/alu.md b/docs/docs/_protocol-specs/public-vm/alu.md → docs/docs/protocol-specs/public-vm/alu.md
diff --git a/.../_protocol-specs/public-vm/avm-circuit.md → ...s/protocol-specs/public-vm/avm-circuit.md b/.../_protocol-specs/public-vm/avm-circuit.md → ...s/protocol-specs/public-vm/avm-circuit.md
diff --git a/.../public-vm/bytecode-validation-circuit.md → .../public-vm/bytecode-validation-circuit.md b/.../public-vm/bytecode-validation-circuit.md → .../public-vm/bytecode-validation-circuit.md
diff --git a/...protocol-specs/public-vm/circuit-index.md → ...protocol-specs/public-vm/circuit-index.md b/...protocol-specs/public-vm/circuit-index.md → ...protocol-specs/public-vm/circuit-index.md
diff --git a/...ocs/_protocol-specs/public-vm/context.mdx → ...docs/protocol-specs/public-vm/context.mdx b/...ocs/_protocol-specs/public-vm/context.mdx → ...docs/protocol-specs/public-vm/context.mdx
diff --git a/..._protocol-specs/public-vm/control-flow.md → .../protocol-specs/public-vm/control-flow.md b/..._protocol-specs/public-vm/control-flow.md → .../protocol-specs/public-vm/control-flow.md
diff --git a/...cs/_protocol-specs/public-vm/execution.md → ...ocs/protocol-specs/public-vm/execution.md b/...cs/_protocol-specs/public-vm/execution.md → ...ocs/protocol-specs/public-vm/execution.md
diff --git a/docs/docs/_protocol-specs/public-vm/index.md → docs/docs/protocol-specs/public-vm/index.md b/docs/docs/_protocol-specs/public-vm/index.md → docs/docs/protocol-specs/public-vm/index.md
diff --git a/...tocol-specs/public-vm/instruction-set.mdx → ...tocol-specs/public-vm/instruction-set.mdx b/...tocol-specs/public-vm/instruction-set.mdx → ...tocol-specs/public-vm/instruction-set.mdx
diff --git a/docs/docs/_protocol-specs/public-vm/intro.md → docs/docs/protocol-specs/public-vm/intro.md b/docs/docs/_protocol-specs/public-vm/intro.md → docs/docs/protocol-specs/public-vm/intro.md
diff --git a/..._protocol-specs/public-vm/memory-model.md → .../protocol-specs/public-vm/memory-model.md b/..._protocol-specs/public-vm/memory-model.md → .../protocol-specs/public-vm/memory-model.md
diff --git a/...protocol-specs/public-vm/nested-calls.mdx → ...protocol-specs/public-vm/nested-calls.mdx b/...protocol-specs/public-vm/nested-calls.mdx → ...protocol-specs/public-vm/nested-calls.mdx
diff --git a/...ocs/_protocol-specs/public-vm/security.md → ...docs/protocol-specs/public-vm/security.md b/...ocs/_protocol-specs/public-vm/security.md → ...docs/protocol-specs/public-vm/security.md
diff --git a/docs/docs/_protocol-specs/public-vm/state.md → docs/docs/protocol-specs/public-vm/state.md b/docs/docs/_protocol-specs/public-vm/state.md → docs/docs/protocol-specs/public-vm/state.md
diff --git a/..._protocol-specs/public-vm/type-structs.md → .../protocol-specs/public-vm/type-structs.md b/..._protocol-specs/public-vm/type-structs.md → .../protocol-specs/public-vm/type-structs.md
diff --git a/...ocol-specs/rollup-circuits/base-rollup.md → ...ocol-specs/rollup-circuits/base-rollup.md b/...ocol-specs/rollup-circuits/base-rollup.md → ...ocol-specs/rollup-circuits/base-rollup.md
diff --git a/.../_protocol-specs/rollup-circuits/index.md → ...s/protocol-specs/rollup-circuits/index.md b/.../_protocol-specs/rollup-circuits/index.md → ...s/protocol-specs/rollup-circuits/index.md
diff --git a/...col-specs/rollup-circuits/merge-rollup.md → ...col-specs/rollup-circuits/merge-rollup.md b/...col-specs/rollup-circuits/merge-rollup.md → ...col-specs/rollup-circuits/merge-rollup.md
diff --git a/...ocol-specs/rollup-circuits/root-rollup.md → ...ocol-specs/rollup-circuits/root-rollup.md b/...ocol-specs/rollup-circuits/root-rollup.md → ...ocol-specs/rollup-circuits/root-rollup.md
diff --git a/...ocol-specs/rollup-circuits/tree-parity.md → ...ocol-specs/rollup-circuits/tree-parity.md b/...ocol-specs/rollup-circuits/tree-parity.md → ...ocol-specs/rollup-circuits/tree-parity.md
diff --git a/docs/docs/_protocol-specs/state/archive.md → docs/docs/protocol-specs/state/archive.md b/docs/docs/_protocol-specs/state/archive.md → docs/docs/protocol-specs/state/archive.md
diff --git a/docs/docs/_protocol-specs/state/index.md → docs/docs/protocol-specs/state/index.md b/docs/docs/_protocol-specs/state/index.md → docs/docs/protocol-specs/state/index.md
diff --git a/...s/_protocol-specs/state/note-hash-tree.md → ...cs/protocol-specs/state/note-hash-tree.md b/...s/_protocol-specs/state/note-hash-tree.md → ...cs/protocol-specs/state/note-hash-tree.md
diff --git a/...s/_protocol-specs/state/nullifier-tree.md → ...cs/protocol-specs/state/nullifier-tree.md b/...s/_protocol-specs/state/nullifier-tree.md → ...cs/protocol-specs/state/nullifier-tree.md
diff --git a/..._protocol-specs/state/public-data-tree.md → .../protocol-specs/state/public-data-tree.md b/..._protocol-specs/state/public-data-tree.md → .../protocol-specs/state/public-data-tree.md
diff --git a/...tocol-specs/state/tree-implementations.md → ...tocol-specs/state/tree-implementations.md b/...tocol-specs/state/tree-implementations.md → ...tocol-specs/state/tree-implementations.md
diff --git a/.../docs/_protocol-specs/state/wonky-tree.md → docs/docs/protocol-specs/state/wonky-tree.md b/.../docs/_protocol-specs/state/wonky-tree.md → docs/docs/protocol-specs/state/wonky-tree.md
diff --git a/docs/docs/_protocol-specs/todo.md → docs/docs/protocol-specs/todo.md b/docs/docs/_protocol-specs/todo.md → docs/docs/protocol-specs/todo.md
diff --git a/...ocs/_protocol-specs/transactions/index.md → ...docs/protocol-specs/transactions/index.md b/...ocs/_protocol-specs/transactions/index.md → ...docs/protocol-specs/transactions/index.md
diff --git a/...col-specs/transactions/local-execution.md → ...col-specs/transactions/local-execution.md b/...col-specs/transactions/local-execution.md → ...col-specs/transactions/local-execution.md
diff --git a/...ol-specs/transactions/public-execution.md → ...ol-specs/transactions/public-execution.md b/...ol-specs/transactions/public-execution.md → ...ol-specs/transactions/public-execution.md
diff --git a/..._protocol-specs/transactions/tx-object.md → .../protocol-specs/transactions/tx-object.md b/..._protocol-specs/transactions/tx-object.md → .../protocol-specs/transactions/tx-object.md
diff --git a/.../_protocol-specs/transactions/validity.md → ...s/protocol-specs/transactions/validity.md b/.../_protocol-specs/transactions/validity.md → ...s/protocol-specs/transactions/validity.md
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -55,7 +55,10 @@ const config = {
             );
           },
           routeBasePath: "/",
-          include: ["**/*.{md,mdx}"],
+          include: process.env.SHOW_PROTOCOL_SPECS
+            ? ['**/*.{md,mdx}']
+            : ['**/*.{md,mdx}', '!protocol-specs/**'],
+
           remarkPlugins: [math],
           rehypePlugins: [
             [
@@ -298,6 +301,13 @@ const config = {
                 label: "Roadmap",
                 className: "no-external-icon",
               },
+              ...(process.env.SHOW_PROTOCOL_SPECS ?
+              [{
+                type: "docSidebar",
+                sidebarId: "protocolSpecSidebar",
+                label: "Protocol Specification",
+                className: "no-external-icon",
+              }] : []),
               {
                 to: "https://noir-lang.org/docs",
                 label: "Noir docs",

diff --git a/docs/package.json b/docs/package.json
@@ -4,8 +4,8 @@
   "private": true,
   "scripts": {
     "docs": "yarn preprocess && yarn typedoc && docusaurus start --host ${HOST:-localhost}",
-    "dev": "HOST=0.0.0.0 ENV=dev yarn docs",
-    "dev:local": "ENV=dev yarn docs",
+    "dev": "HOST=0.0.0.0 ENV=dev SHOW_PROTOCOL_SPECS=true yarn docs",
+    "dev:local": "ENV=dev SHOW_PROTOCOL_SPECS=true yarn docs",
     "build": "./scripts/build.sh",
     "swizzle": "docusaurus swizzle",
     "clean": "./scripts/clean.sh",

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -168,4 +168,226 @@ export default {
       dirName: "aztec/roadmap",
     },
   ],
+
+  ...(process.env.SHOW_PROTOCOL_SPECS ? {
+  protocolSpecSidebar: [
+    "protocol-specs/intro",
+    {
+      label: "Cryptography",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/cryptography/index" },
+      items: [
+        {
+          label: "Proving System",
+          type: "category",
+          items: [
+            "protocol-specs/cryptography/proving-system/performance-targets",
+            "protocol-specs/cryptography/proving-system/overview",
+            "protocol-specs/cryptography/proving-system/data-bus",
+          ],
+        },
+        {
+          label: "Hashing",
+          type: "category",
+          items: [
+            "protocol-specs/cryptography/hashing/hashing",
+            "protocol-specs/cryptography/hashing/poseidon2",
+            "protocol-specs/cryptography/hashing/pedersen",
+          ],
+        },
+        "protocol-specs/cryptography/merkle-trees",
+      ],
+    },
+    {
+      label: "Addresses & Keys",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/addresses-and-keys/index" },
+      items: [
+        "protocol-specs/addresses-and-keys/address",
+        "protocol-specs/addresses-and-keys/keys-requirements",
+        "protocol-specs/addresses-and-keys/keys",
+        {
+          label: "Example Usage of Keys",
+          type: "category",
+          items: [
+            "protocol-specs/addresses-and-keys/example-usage/nullifier",
+            "protocol-specs/addresses-and-keys/example-usage/diversified-and-stealth-keys",
+            "protocol-specs/addresses-and-keys/example-usage/tag-sequence-derivation",
+            "protocol-specs/addresses-and-keys/example-usage/encrypt-and-tag",
+          ],
+        },
+        "protocol-specs/addresses-and-keys/precompiles",
+        "protocol-specs/addresses-and-keys/diversified-and-stealth",
+      ],
+    },
+    {
+      label: "State",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/state/index" },
+      items: [
+        "protocol-specs/state/tree-implementations",
+        "protocol-specs/state/archive",
+        "protocol-specs/state/note-hash-tree",
+        "protocol-specs/state/nullifier-tree",
+        "protocol-specs/state/public-data-tree",
+        "protocol-specs/state/wonky-tree",
+      ],
+    },
+    {
+      label: "Transactions",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/transactions/index" },
+      items: [
+        "protocol-specs/transactions/local-execution",
+        "protocol-specs/transactions/public-execution",
+        "protocol-specs/transactions/tx-object",
+        "protocol-specs/transactions/validity",
+      ],
+    },
+    {
+      label: "Bytecode",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/bytecode/index" },
+      items: [],
+    },
+    {
+      label: "Contract Deployment",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/contract-deployment/index" },
+      items: [
+        "protocol-specs/contract-deployment/classes",
+        "protocol-specs/contract-deployment/instances",
+      ],
+    },
+    {
+      label: "Calls",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/calls/index" },
+      items: [
+        "protocol-specs/calls/sync-calls",
+        "protocol-specs/calls/enqueued-calls",
+        "protocol-specs/calls/batched-calls",
+        "protocol-specs/calls/static-calls",
+        "protocol-specs/calls/unconstrained-calls",
+        "protocol-specs/calls/public-private-messaging",
+      ],
+    },
+    {
+      label: "L1 smart contracts",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/l1-smart-contracts/index" },
+      items: ["protocol-specs/l1-smart-contracts/frontier"],
+    },
+    {
+      label: "Data availability",
+      type: "category",
+      link: {
+        type: "doc",
+        id: "protocol-specs/data-publication-and-availability/index",
+      },
+      items: [
+        "protocol-specs/data-publication-and-availability/overview",
+        "protocol-specs/data-publication-and-availability/published-data",
+      ],
+    },
+    {
+      label: "Logs",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/logs/index" },
+      items: [],
+    },
+    {
+      label: "Pre-compiled Contracts",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/pre-compiled-contracts/index" },
+      items: ["protocol-specs/pre-compiled-contracts/registry"],
+    },
+    {
+      label: "Private Message Delivery",
+      type: "category",
+      link: {
+        type: "doc",
+        id: "protocol-specs/private-message-delivery/index",
+      },
+      items: [
+        "protocol-specs/private-message-delivery/private-msg-delivery", // renamed to avoid routing problems
+        "protocol-specs/private-message-delivery/send-note-guidelines",
+      ],
+    },
+    {
+      label: "Gas & Fees",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/gas-and-fees/index" },
+      items: [
+        "protocol-specs/gas-and-fees/fee-juice",
+        "protocol-specs/gas-and-fees/specifying-gas-fee-info",
+        "protocol-specs/gas-and-fees/tx-setup-and-teardown",
+        "protocol-specs/gas-and-fees/kernel-tracking",
+        "protocol-specs/gas-and-fees/fee-schedule",
+        "protocol-specs/gas-and-fees/published-gas-and-fee-data",
+      ],
+    },
+    {
+      label: "Decentralization",
+      type: "category",
+      items: [
+        "protocol-specs/decentralization/actors",
+        "protocol-specs/decentralization/governance",
+        "protocol-specs/decentralization/block-production",
+        "protocol-specs/decentralization/p2p-network",
+      ],
+    },
+    {
+      label: "Circuits",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/circuits/high-level-topology" },
+      items: [
+        "protocol-specs/circuits/private-function",
+        "protocol-specs/circuits/private-kernel-initial",
+        "protocol-specs/circuits/private-kernel-inner",
+        "protocol-specs/circuits/private-kernel-reset",
+        "protocol-specs/circuits/private-kernel-tail",
+        "protocol-specs/circuits/public-kernel-initial",
+        "protocol-specs/circuits/public-kernel-inner",
+        "protocol-specs/circuits/public-kernel-tail",
+      ],
+    },
+    {
+      label: "Rollup Circuits",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/rollup-circuits/index" },
+      items: [
+        "protocol-specs/rollup-circuits/base-rollup",
+        "protocol-specs/rollup-circuits/merge-rollup",
+        "protocol-specs/rollup-circuits/tree-parity",
+        "protocol-specs/rollup-circuits/root-rollup",
+      ],
+    },
+    {
+      label: "Aztec (Public) VM",
+      type: "category",
+      link: { type: "doc", id: "protocol-specs/public-vm/index" },
+      items: [
+        "protocol-specs/public-vm/intro",
+        "protocol-specs/public-vm/state",
+        "protocol-specs/public-vm/memory-model",
+        "protocol-specs/public-vm/context",
+        "protocol-specs/public-vm/execution",
+        "protocol-specs/public-vm/nested-calls",
+        "protocol-specs/public-vm/instruction-set",
+        {
+          label: "AVM Circuit",
+          type: "category",
+          link: { type: "doc", id: "protocol-specs/public-vm/circuit-index" },
+          items: [
+            "protocol-specs/public-vm/avm-circuit",
+            "protocol-specs/public-vm/control-flow",
+            "protocol-specs/public-vm/alu",
+            "protocol-specs/public-vm/bytecode-validation-circuit",
+          ],
+        },
+        "protocol-specs/public-vm/type-structs",
+      ],
+    },
+  ]}: {}),
 };