[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',
+        },
       ],
     },
     {
@@ -99,18 +103,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',
@@ -303,10 +295,10 @@ function sidebarChain(): DefaultTheme.SidebarItem[] {
   ]
 }
 
-function sidebarAPI(): DefaultTheme.SidebarItem[] {
+function sidebarReference(): DefaultTheme.SidebarItem[] {
   return [
     {
-      text: 'About',
+      text: 'Reference',
       items: [
         {
           text: 'Glossary',
@@ -316,23 +308,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 +324,30 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
           text: 'Permissions',
           link: '/reference/permissions.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',
+        },
       ],
     },
   ]
@@ -465,13 +464,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)

etc/meta.ts

@@ -1,7 +1,7 @@
 /**
- * hyperledger-iroha/iroha#iroha2-dev
+ * `main` as of 2024/11/13
  */
-export const IROHA_REV_DEV = 'e7a605c1a926c319d214ef3825524ee6c2e9f076'
+export const IROHA_REV_DEV = '2a30fc97087d48f0aa95ef0382038c4a06288828'
 
 /**
  * hyperledger-iroha/iroha-javascript#iroha2 (rc13)

etc/snippet-sources.ts

@@ -116,18 +116,18 @@ export default [
     src: './src/example_code/lorem.rs',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/configs/client.template.toml`,
-    filename: 'client-cli-config-template.toml',
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/docs/source/references/client.template.toml`,
+    // filename: 'client-cli-config-template.toml',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/configs/peer.template.toml`,
-    filename: 'peer-config-template.toml',
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/docs/source/references/peer.template.toml`,
+    // filename: 'peer-config-template.toml',
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/configs/swarm/genesis.json`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/defaults/genesis.json`,
   },
   {
-    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/client/examples/tutorial.rs`,
+    src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_REV_DEV}/crates/iroha/examples/tutorial.rs`,
     filename: 'tutorial-snippets.rs',
   },
 

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

src/guide/configure/client-configuration.md

@@ -4,7 +4,7 @@ Let's look at the client configuration options.
 
 ::: details Client configuration template
 
-<<< @/snippets/client-cli-config-template.toml
+<<< @/snippets/client.template.toml
 
 :::
 
@@ -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/peer-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.