[docs]: add configuration reference (#397)

Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Co-authored-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
Co-authored-by: yamkovoy <100563712+yamkovoy@users.noreply.github.com>
Co-authored-by: qua <quacumque@fastmail.jp>

Author: 4 people

.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'
@@ -28,7 +28,7 @@ function nav(): DefaultTheme.NavItem[] {
     {
       text: 'Reference',
       link: '/reference/torii-endpoints',
-      activeMatch: '/reference/',
+      activeMatch: '^/reference/',
     },
     {
       text: 'Help',
@@ -93,6 +93,10 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
           text: 'JavaScript',
           link: '/guide/tutorials/javascript',
         },
+        {
+          text: 'Compatibility Matrix',
+          link: '/reference/compatibility-matrix',
+        },
       ],
     },
     {
@@ -103,18 +107,6 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
           text: 'Configure Iroha',
           collapsed: true,
           items: [
-            {
-              text: 'Configuration Types',
-              link: '/guide/configure/configuration-types',
-            },
-            {
-              text: 'Samples',
-              link: '/guide/configure/sample-configuration',
-            },
-            {
-              text: 'Peer Configuration',
-              link: '/guide/configure/peer-configuration',
-            },
             {
               text: 'Client Configuration',
               link: '/guide/configure/client-configuration',
@@ -307,10 +299,10 @@ function sidebarChain(): DefaultTheme.SidebarItem[] {
   ]
 }
 
-function sidebarAPI(): DefaultTheme.SidebarItem[] {
+function sidebarReference(): DefaultTheme.SidebarItem[] {
   return [
     {
-      text: 'About',
+      text: 'Reference',
       items: [
         {
           text: 'Glossary',
@@ -320,23 +312,6 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
           text: 'Naming Conventions',
           link: '/reference/naming.md',
         },
-        {
-          text: 'Compatibility Matrix',
-          link: '/reference/compatibility-matrix',
-        },
-        {
-          text: 'Foreign Function Interfaces',
-          link: '/reference/ffi',
-        },
-      ],
-    },
-    {
-      text: 'Reference',
-      items: [
-        {
-          text: 'Torii Endpoints',
-          link: '/reference/torii-endpoints.md',
-        },
         {
           text: 'Data Model Schema',
           link: '/reference/data-model-schema',
@@ -357,6 +332,30 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
           text: 'Binaries',
           link: '/reference/binaries.md',
         },
+        {
+          text: 'irohad CLI',
+          link: '/reference/irohad-cli.md',
+        },
+        {
+          text: 'Torii HTTP API',
+          link: '/reference/torii-endpoints.md',
+        },
+        {
+          text: 'Foreign Function Interfaces',
+          link: '/reference/ffi',
+        },
+        {
+          text: 'Peer Configuration',
+          link: '/reference/peer-config/index.md',
+          items: [
+            { text: 'Parameters', link: '/reference/peer-config/params.md' },
+            { text: 'Migration from pre-rc.20', link: '/reference/peer-config/migration.md' },
+          ],
+        },
+        {
+          text: 'Genesis Block',
+          link: '/reference/genesis.md',
+        },
       ],
     },
   ]
@@ -473,13 +472,12 @@ export default defineConfig({
     },
 
     nav: nav(),
-    outline: [2, 3],
 
     sidebar: {
       '/get-started/': sidebarStart(),
       '/guide/': sidebarGuide(),
       '/blockchain/': sidebarChain(),
-      '/reference/': sidebarAPI(),
+      '/reference/': sidebarReference(),
       '/help/': sidebarHelp(),
     },
 

.vitepress/theme/style/index.scss

@@ -1,9 +1,13 @@
-@import url('https://fonts.googleapis.com/css2?family=Sora:wght@100..800&display=swap');
+@import url("https://fonts.googleapis.com/css2?family=Sora:wght@100..800&display=swap");
 
 :root {
-  --vp-font-family-mono: 'JetBrains Mono', 'Fira Code', Menlo, Monaco, Consolas, 'Courier New', monospace;
-  --vp-font-family-base: 'Sora', 'Inter', ui-sans-serif, system-ui, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';
-  
+  --vp-font-family-mono:
+    "JetBrains Mono", "Fira Code", Menlo, Monaco, Consolas, "Courier New",
+    monospace;
+  --vp-font-family-base:
+    "Sora", "Inter", ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji",
+    "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+
   --vp-c-brand-1: var(--vp-c-red-1);
   --vp-c-brand-2: var(--vp-c-red-2);
   --vp-c-brand-3: var(--vp-c-red-3);
@@ -15,7 +19,11 @@
   color: var(--vp-c-text-1);
 }
 
-.VPSidebarItem.level-1 .text, .VPSidebarItem.level-2 .text, .VPSidebarItem.level-3 .text, .VPSidebarItem.level-4 .text, .VPSidebarItem.level-5 .text {
+.VPSidebarItem.level-1 .text,
+.VPSidebarItem.level-2 .text,
+.VPSidebarItem.level-3 .text,
+.VPSidebarItem.level-4 .text,
+.VPSidebarItem.level-5 .text {
   font-weight: 400 !important;
   color: var(--vp-c-text-2);
 }
@@ -25,7 +33,7 @@
 }
 
 .vp-doc {
-  div[class*='language-'] {
+  div[class*="language-"] {
     pre {
       font-size: 14px;
       font-variant-ligatures: none;
@@ -44,4 +52,21 @@
     line-height: 1.75;
     font-weight: 300;
   }
+
+  tr.transposed-table:nth-child(2n+1) {
+    background: var(--vp-c-bg-soft);
+
+    pre {
+      border: 1px solid var(--vp-c-divider);
+      border-radius: 8px;
+    }
+  }
+
+  tr.transposed-table:nth-child(2n) {
+    background: transparent;
+  }
+
+  section.footnotes {
+    font-size: 0.8rem;
+  }
 }

etc/snippet-sources.ts

@@ -117,11 +117,9 @@ export default [
   },
   {
     src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/client.template.toml`,
-    filename: 'client-cli-config-template.toml',
   },
   {
     src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/peer.template.toml`,
-    filename: 'peer-config-template.toml',
   },
   {
     src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/defaults/genesis.json`,

src/blockchain/wasm.md

@@ -78,9 +78,9 @@ non-portable architecture and OS-specific static manner, but WASM is a
 portable format. Since C ABI is the _lingua franca_ of the programming
 world and there is no other stable Rust ABI (yet), Iroha relies on the
 C-linkage to generate WASM bindings. Thankfully, `iroha_wasm` takes care of
-everything related to [foreign function interfaces](/reference/ffi.md) (FFI), so
-you don't have to worry about things like `unsafe`, `repr(C)`, padding,
-alignment, and others.
+everything related to [foreign function interfaces](/reference/ffi.md)
+(FFI), so you don't have to worry about things like `unsafe`, `repr(C)`,
+padding, alignment, and others.
 
 The `iroha_wasm` crate contains all of the bindings, macros, and trait
 implementations that you'd need to write the program, most notably the

src/blockchain/world.md

@@ -4,8 +4,7 @@
 consists of:
 
 - Iroha [configuration parameters](/guide/configure/client-configuration.md)
-- the list of
-  [trusted peers](/guide/configure/peer-configuration#trusted-peers)
+- TODO: peers
 - registered domains
 - registered [triggers](/blockchain/triggers.md)
 - registered

src/guide/advanced/metrics.md

@@ -19,12 +19,6 @@ This topic will be updated as part of the new configuration reference.
 The progress on the configuration reference can be tracked in the following GitHub issue:\
 [iroha-2-docs > Issue #392: Tracking issue for Configuration Reference as per RFC](https://github.com/hyperledger-iroha/iroha-2-docs/issues/392).
 
-::: note
-
-For examples, see [Sample Configuration Files](../configure/sample-configuration.md).
-
-:::
-
 After the above is configured, you can use the IP address set in the `"TORII_TELEMETRY_URL"` variable to access the metrics data from within a running Iroha instance.
 
 **Example**:

src/guide/advanced/running-iroha-on-bare-metal.md

@@ -12,19 +12,12 @@ error-prone, particularly for exotic systems (Windows).
 ::: info
 
 For this chapter, we assume you have learned about
-[configuration](/guide/configure/sample-configuration.md) and
 [management](/guide/configure/peer-management.md) in Iroha 2. Here we offer
 you instructions to run Iroha on bare metal without going into details
 about various configuration options available.
 
-You can always check
-[sample configuration files](/guide/configure/sample-configuration.md) for
-`configs/peer/genesis.json` and `configs/peer/config.json`, or refer to
-[peer configuration options](/guide/configure/peer-configuration.md) for
-more details.
+TODO extend with a relevant config guide
 
-<!-- TODO: Add the new configuration reference, once its ready. Issue: https://github.com/hyperledger-iroha/iroha-2-docs/issues/392
-The full list of available options is in the [Iroha Configuration Reference](https://github.com/hyperledger-iroha/iroha/blob/iroha2-dev/docs/source/references/config.md). -->
 
 :::
 
@@ -448,13 +441,11 @@ Iroha in the real world.
     ```
 
 3.  Register your peer to a network, and make sure to add at least four of
-    the peers on that network to the
-    [`TRUSTED_PEERS`](/guide/configure/peer-configuration.md#trusted-peers)
+    the peers on that network to the trusted peers
     array in your configuration file.
 
-4.  Determine the web socket that the other peers will use to connect to
-    you. Make sure that the port is open and use that address
-    ([`P2P_ADDR`](/guide/configure/peer-configuration.md#p2p-addr)) in your
+4.  Determine the socket address that the other peers will use to connect to
+    you. Make sure that the port is open and use that address in your
     `configs/peer/config.json` file.
 
 5.  After you have finished editing the configuration file, deploy Iroha by