[docs]: add configuration reference

.vitepress/config.mts

@@ -1,6 +1,6 @@
 /// <reference types="vite/client" />
 
-import { defineConfig, DefaultTheme } from 'vitepress'
+import { DefaultTheme, defineConfig } from 'vitepress'
 import footnote from 'markdown-it-footnote'
 import { resolve } from 'path'
 import ViteSvgLoader from 'vite-svg-loader'
@@ -12,6 +12,7 @@ function nav(): DefaultTheme.NavItem[] {
   return [
     {
       text: 'Guide',
+      activeMatch: '^/$|^/guide/',
       items: [
         // { text: 'Get Started', link: '/guide/get-started/index' },
         // { text: 'Build and Install', link: '/guide/get-started/install' },
@@ -33,12 +34,12 @@ function nav(): DefaultTheme.NavItem[] {
     {
       text: 'Reference',
       link: '/reference/torii-endpoints',
-      activeMatch: '/reference/',
+      activeMatch: '^/reference/',
     },
   ]
 }
 
-function sidebarAPI(): DefaultTheme.SidebarItem[] {
+function sidebarReference(): DefaultTheme.SidebarItem[] {
   return [
     {
       text: 'About',
@@ -64,9 +65,13 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
     {
       text: 'Reference',
       items: [
+        {
+          text: 'CLI',
+          link: '/reference/cli',
+        },
         {
           text: 'Torii Endpoints',
-          link: '/reference/torii-endpoints.md',
+          link: '/reference/torii-endpoints',
         },
         {
           text: 'Data Model Schema',
@@ -78,11 +83,89 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
         },
         {
           text: 'Queries',
-          link: '/reference/queries.md',
+          link: '/reference/queries',
         },
         {
           text: 'Permissions',
-          link: '/reference/permissions.md',
+          link: '/reference/permissions',
+        },
+        {
+          text: 'Genesis Block',
+          link: '/reference/genesis'
+        }
+      ],
+    },
+    {
+      text: 'Configuration',
+      items: [
+        {
+          text: 'Overview',
+          link: '/reference/config/',
+        },
+        {
+          text: 'Parameters',
+          items: [
+            // TODO: consider re-ordering sections to a more intuitive format?
+            {
+              text: 'Base',
+              link: '/reference/config/base-params',
+            },
+            {
+              text: 'Genesis',
+              link: '/reference/config/genesis-params',
+            },
+            {
+              text: 'Network',
+              link: '/reference/config/network-params',
+            },
+            {
+              text: 'Torii',
+              link: '/reference/config/torii-params',
+            },
+            {
+              text: 'Sumeragi',
+              link: '/reference/config/sumeragi-params',
+            },
+            {
+              text: 'Kura',
+              link: '/reference/config/kura-params',
+            },
+            {
+              text: 'Logger',
+              link: '/reference/config/logger-params',
+            },
+            {
+              text: 'Queue',
+              link: '/reference/config/queue-params',
+            },
+            {
+              text: 'Snapshot',
+              link: '/reference/config/snapshot-params',
+            },
+            {
+              text: 'Telemetry',
+              link: '/reference/config/telemetry-params',
+            },
+            {
+              text: 'Chain Wide',
+              link: '/reference/config/chain-wide-params',
+            },
+          ],
+        },
+        {
+          text: 'Glossary',
+          link: '/reference/config/glossary',
+        },
+      ],
+    },
+    {
+      text: 'Client CLI',
+      items: [
+        {
+          text: 'CLI',
+        },
+        {
+          text: 'Configuration',
         },
       ],
     },
@@ -476,11 +559,10 @@ export default defineConfig({
     },
 
     nav: nav(),
-    outline: [2, 3],
 
     sidebar: {
       '/guide/': sidebarGuide(),
-      '/reference/': sidebarAPI(),
+      '/reference/': sidebarReference(),
     },
 
     search: {

.vitepress/theme/components/ConfigParameterSpecs.vue

@@ -0,0 +1,65 @@
+<script setup lang="ts">
+import { computed } from 'vue'
+import { computedEager } from '@vueuse/core'
+import { withBase } from 'vitepress'
+import { match, P } from 'ts-pattern'
+
+const props = defineProps<{
+  type: 'string' | 'number' | 'socket-addr' | 'duration' | 'bytes' | 'private-key' | 'multihash' | 'file-path'
+  defaultValue?: string
+  env?: boolean | string
+}>()
+
+function glossaryLink(text: string, id: string) {
+  return { text, url: withBase(`/reference/config/glossary#${id}`) }
+}
+
+const typeModel = computed(() => {
+  type Result = (string | { url: string; text: string })[]
+
+  return match(props.type)
+    .returnType<Result>()
+    .with('string', () => ['String'])
+    .with('number', () => ['Number'])
+    .with('socket-addr', () => ['String, ', glossaryLink('Socket Address', 'type-socket-address')])
+    .with('duration', () => ['String, ', glossaryLink('Duration', 'type-duration')])
+    .with('bytes', () => ['String, ', glossaryLink('Bytes', 'type-bytes')])
+    .with('private-key', () => ['Table, ', glossaryLink('Private Key', 'type-private-key')])
+    .with('multihash', () => ['String, ', glossaryLink('Multihash', 'type-multihash')])
+      .with('file-path', () => ['String, file path'])
+    .exhaustive()
+})
+</script>
+
+<template>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th v-if="env">Environment Alias</th>
+        <th v-if="defaultValue">Default</th>
+        <th v-else></th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>
+          <template v-for="item in typeModel">
+            <template v-if="typeof item === 'string'">{{ item }}</template>
+            <a v-else :href="item.url">{{ item.text }}</a>
+          </template>
+        </td>
+        <td v-if="env">
+          <code v-if="typeof env === 'string'">{{ env }}</code>
+          <slot name="env" v-else />
+        </td>
+        <td v-if="defaultValue">
+          {{ defaultValue }}
+        </td>
+        <td v-else>
+          <b>Required</b>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</template>

.vitepress/theme/index.ts

@@ -22,5 +22,9 @@ export default {
       'CompatibilityMatrixTableIcon',
       defineAsyncComponent(async () => import('./components/CompatibilityMatrixTableIcon.vue')),
     )
+    app.component(
+      'ConfigParameterSpecs',
+      defineAsyncComponent(() => import('./components/ConfigParameterSpecs.vue')),
+    )
   },
 }

package.json

@@ -12,7 +12,7 @@
     "lint": "eslint --ext .js,.ts,.mts,.vue . .vitepress",
     "typecheck": "tsc --noEmit",
     "get-snippets": "pnpm cli get-snippets",
-    "test": "vitest",
+    "test": "VITE_CJS_IGNORE_WARNING=true vitest",
     "cli": "tsx etc/cli"
   },
   "devDependencies": {
@@ -23,15 +23,15 @@
     "@types/markdown-it": "^13.0.1",
     "@types/node": "^20.6.0",
     "@types/yargs": "^17.0.24",
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
-    "@typescript-eslint/parser": "^6.6.0",
-    "@unocss/transformer-directives": "=0.55.7",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "@unocss/transformer-directives": "^0.58.5",
     "case": "^1.6.3",
     "chalk": "^4",
     "css-select": "^5.1.0",
     "del": "^7.0.0",
-    "eslint": "^8.49.0",
-    "eslint-plugin-vue": "^9.17.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-vue": "^9.21.1",
     "fast-diff": "^1.3.0",
     "globby": "^13.2.2",
     "hasha": "^5.2.2",
@@ -42,27 +42,27 @@
     "markdown-it-footnote": "^3.0.3",
     "mermaid": "^10.4.0",
     "node-fetch": "^3.3.0",
-    "prettier": "^2.8.8",
-    "prettier-eslint": "^15.0.1",
-    "prettier-eslint-cli": "^7.1.0",
+    "prettier": "^3.2.5",
+    "prettier-eslint": "^16.3.0",
+    "prettier-eslint-cli": "^8.0.1",
     "sass": "^1.66.1",
-    "ts-pattern": "^5.0.5",
-    "tsx": "^3.12.7",
-    "typescript": "5.2.2",
-    "unocss": "=0.55.7",
-    "vite": "^4.4.9",
-    "vite-svg-loader": "^4.0.0",
-    "vitepress": "1.0.0-rc.14",
-    "vitest": "^0.34.3",
+    "ts-pattern": "^5.0.6",
+    "tsx": "^4.7.1",
+    "typescript": "5.3.3",
+    "unocss": "^0.58.5",
+    "vite": "^5.1.1",
+    "vite-svg-loader": "^5.1.0",
+    "vitepress": "1.0.0-rc.42",
+    "vitest": "^1.2.2",
     "yargs": "^17.6.2"
   },
   "dependencies": {
-    "@headlessui/vue": "^1.7.16",
+    "@headlessui/vue": "^1.7.19",
     "@vue-kakuyaku/core": "^0.4.3",
-    "@vueuse/core": "^10.4.1",
-    "@vueuse/math": "^10.4.1",
-    "mande": "^2.0.7",
+    "@vueuse/core": "^10.7.2",
+    "@vueuse/math": "^10.7.2",
+    "mande": "^2.0.8",
     "tiny-invariant": "^1.3.1",
-    "vue": "^3.3.4"
+    "vue": "^3.4.18"
   }
 }