[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'
@@ -28,7 +28,7 @@ function nav(): DefaultTheme.NavItem[] {
     {
       text: 'Reference',
       link: '/reference/torii-endpoints',
-      activeMatch: '/reference/',
+      activeMatch: '^/reference/',
     },
     {
       text: 'Help',
@@ -89,6 +89,10 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
           text: 'JavaScript',
           link: '/guide/tutorials/javascript',
         },
+        {
+          text: 'Compatibility Matrix',
+          link: '/reference/compatibility-matrix',
+        },
       ],
     },
     {
@@ -303,10 +307,10 @@ function sidebarChain(): DefaultTheme.SidebarItem[] {
   ]
 }
 
-function sidebarAPI(): DefaultTheme.SidebarItem[] {
+function sidebarReference(): DefaultTheme.SidebarItem[] {
   return [
     {
-      text: 'About',
+      text: 'Reference',
       items: [
         {
           text: 'Glossary',
@@ -316,23 +320,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',
@@ -349,6 +336,34 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
           text: 'Permissions',
           link: '/reference/permissions.md',
         },
+        {
+          text: 'CLI',
+        },
+        {
+          text: 'Torii HTTP API',
+          link: '/reference/torii-endpoints.md',
+        },
+        {
+          text: 'Foreign Function Interfaces',
+          link: '/reference/ffi',
+        },
+      ],
+    },
+    {
+      text: 'Configuration',
+      items: [
+        { text: 'Overview' },
+        {
+          text: 'Peer Configuration',
+          link: '/reference/config/index.md',
+          items: [
+            { text: 'Parameters', link: '/reference/config/params.md' },
+            // Consider removal
+            { text: 'Migration from pre-rc.20', link: '/reference/config/migration.md' },
+          ],
+        },
+        { text: 'Genesis Block' },
+        { text: 'On-Chain Configuration' },
       ],
     },
   ]
@@ -465,13 +480,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/index.ts

@@ -10,7 +10,7 @@ import './style/index.scss'
 import { defineAsyncComponent } from 'vue'
 
 export default {
-  ...ThemeDefault,
+  extends: ThemeDefault,
   Layout: LayoutCustom,
   enhanceApp({ app }: EnhanceAppContext) {
     app.component('MermaidRenderWrap', MermaidRenderWrap)

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/guide/configure/client-configuration.md

@@ -24,26 +24,26 @@ For details on cryptographic keys, see [Public Key Cryptography](../security/pub
 
 ## User account
 
-The `ACCOUNT_ID` should be self-explanatory. The only thing you need to
-worry about is that the account must already exist in the blockchain. In
-other words, the account you provide here should already be
+The `ACCOUNT_ID` should be self-explanatory. The only thing you need to worry about is that the account must already
+exist in the blockchain. In other words, the account you provide here should already be
 [registered](/blockchain/instructions.md#un-register).
 
 ::: info Note
 
-Iroha is **case-sensitive**, meaning that _Alice_@wonderland is different
-from _alice_@wonderland. It should go without saying that
-_alice@wonderland_ is not the same as _alice@looking_glass_ either, since
-these accounts belong to different domains, `wonderland` and
-`looking_glass`.
+Iroha is **case-sensitive**, meaning that _Alice_@wonderland is different from _alice_@wonderland. It should go without
+saying that _alice@wonderland_ is not the same as _alice@looking_glass_ either, since these accounts belong to different
+domains, `wonderland` and `looking_glass`.
 
 :::
 
 ## Basic Authentication Credentials
 
-The idea of basic authentication credentials is to provide the access control using a web server with a reverse proxy like [Nginx](https://www.nginx.com/) while these credentials are ignored by the Iroha peers.
+The idea of basic authentication credentials is to provide the access control using a web server with a reverse proxy
+like [Nginx](https://www.nginx.com/) while these credentials are ignored by the Iroha peers.
 
-The login and password will be filled by the client and used for the [`Authorization`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) HTTP [header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
+The login and password will be filled by the client and used for the
+[`Authorization`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) HTTP
+[header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
 
 Use this style of configuration to provide the basic authentication credentials (login and password):
 
@@ -56,49 +56,26 @@ Use this style of configuration to provide the basic authentication credentials
 
 ## Iroha Public Addresses
 
-`TORII` is the module in charge of handling incoming and outgoing
-connections. For client configuration, you can set up two addresses:
-`TORII_API_URL` and `TORII_TELEMETRY_URL`.
+`TORII` is the module in charge of handling incoming and outgoing connections. For client configuration, you can set up
+two addresses: `TORII_API_URL` and `TORII_TELEMETRY_URL`.
 
 ### `TORII_API_URL`
 
-First, the `TORII_API_URL` is the same as `TORII` `API_URL` in the
-[peer configuration](peer-configuration.md#api-url). This is the module
-responsible for handling incoming and outgoing connections. You should also
-add the prefix `http://` or (_preferably_) `https://` to the address. For
-example:
+First, the `TORII_API_URL` is the same as
+[`torii.address` in the peer configuration](/reference/config/params#param-torii-address). This is the module
+responsible for handling incoming and outgoing connections. You should also add the prefix `http://` or (_preferably_)
+`https://` to the address. For example:
 
 ```json
-"TORII_API_URL": "http://127.0.0.1:8080"
-```
-
-### `TORII_TELEMETRY_URL`
-
-The `TORII_TELEMETRY_URL` is used to specify the prometheus endpoint
-address. You can set `TORII_TELEMETRY_URL` like this:
-
-```json
-"TORII_TELEMETRY_URL": "http://127.0.0.1:8180"
+{
+  "TORII_API_URL": "http://127.0.0.1:8080"
+}
 ```
 
-A `GET` request to the `127.0.0.1:8180/status` will give you a JSON-encoded
-representation of the top-level metrics, while a `GET` request to
-`127.0.0.1:8180/metrics` will give you a (somewhat verbose) list of all
-available metrics gathered in Iroha. You might want to change this if
-you're having trouble gathering metrics using `prometheus`.
-
-::: info
-
-Learn how to [monitor Iroha performance](/guide/advanced/metrics.md) using
-prometheus.
-
-:::
-
 ## Transaction Limits
 
-You can specify the transaction limits that each transaction must adhere
-to: the maximum number of instructions and the maximum size of a WASM blob
-(in bytes). For example:
+You can specify the transaction limits that each transaction must adhere to: the maximum number of instructions and the
+maximum size of a WASM blob (in bytes). For example:
 
 ```json
 {
@@ -109,9 +86,8 @@ to: the maximum number of instructions and the maximum size of a WASM blob
 
 ## Transaction TTL and Timeout
 
-Configure the time-to-live (TTL) for transactions and the timeout to wait
-for the status. Both values have to be provided in milliseconds. For
-example:
+Configure the time-to-live (TTL) for transactions and the timeout to wait for the status. Both values have to be
+provided in milliseconds. For example:
 
 ```json
 "TRANSACTION_TIME_TO_LIVE_MS": 100000,
@@ -120,5 +96,5 @@ example:
 
 ## Transaction Nonce
 
-If you set `ADD_TRANSACTION_NONCE` to `true`, Iroha will create different
-hashes for transactions that occur repeatedly and simultaneously.
+If you set `ADD_TRANSACTION_NONCE` to `true`, Iroha will create different hashes for transactions that occur repeatedly
+and simultaneously.

src/guide/configure/genesis.md

@@ -10,8 +10,8 @@ empty, even if `configs/peer/genesis.json` is. Here's an example:
 :::
 
 The **genesis account** is specified in the
-[peer configuration](./peer-configuration.md#genesis) file,
-`configs/peer/config.json`. This is the account that will submit the
+[`genesis` section of the peer configuration](/reference/config/params#genesis) file.
+This is the account that will submit the
 genesis block. The genesis account is like a super user account that has
 elevated privileges, but only during the genesis round. The genesis account
 should be signed by one of the peers, or, in other words, it should have
@@ -80,10 +80,3 @@ You can use `kagami` to generate the default genesis block:
   ```
 
 The genesis block should be located in `configs/peer/genesis.json`.
-
-## Configuration
-
-As we already explained, _genesis account_ is specified in the peer
-configuration file, `configs/peer/config.json`. You can use the same
-configuration file to fine-tune other
-[genesis block configurations](./peer-configuration.md#genesis).

src/guide/configure/peer-configuration.md

@@ -32,15 +32,6 @@ following:
   <!-- 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). -->
 
-::: info
-
-Configuration options have different underlying types and default values,
-which are denoted in code as types wrapped in a single `Option<..>` or in a
-double `Option<Option<..>>`. Refer to
-[configuration types](./configuration-types.md) for details.
-
-:::
-
 ## Generation
 
 You can use `kagami` to generate the default peer configuration: