diff --git a/docs/website/blog/2024-09-24-client-wasm-unstable-breaking-change.md b/docs/website/blog/2024-09-24-client-wasm-unstable-breaking-change.md index a47d857c49b..13f5119c3a1 100644 --- a/docs/website/blog/2024-09-24-client-wasm-unstable-breaking-change.md +++ b/docs/website/blog/2024-09-24-client-wasm-unstable-breaking-change.md @@ -7,11 +7,11 @@ tags: [mithril client, cli, breaking-change] ### Breaking change introduced in the unstable features of the Mithril client WASM -With the release of the new distribution [2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1), we have introduced a breaking change to the **Mithril client WASM** version `0.4.1`: the activation of the unstable features is now done with a **configuration option of the client** instead of using the special `.unstable` property of the client. +With the release of [distribution 2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1), we introduced a breaking change to the **Mithril client WASM** version `0.4.1`. Unstable features are now activated using a **configuration option** instead of the `.unstable` property. -This means that when a new `unstable` feature is switched to `stable`, there will be no breaking change in the developers code using the Mithril client WASM, thus providing a seamless transition and a better developer experience. +This change ensures a seamless transition when new `unstable` features become `stable`, eliminating breaking changes in developer code and enhancing the developer experience. -Here is the code used to activate the `unstable` features with the client options: +To activate `unstable` features, use the following code: ```js let client = new MithrilClient(aggregator_endpoint, genesis_verification_key, { @@ -41,4 +41,4 @@ let mithril_stake_distributions_message = The Mithril client WASM documentation is available [here](https://mithril.network/doc/manual/developer-docs/nodes/mithril-client-library-wasm). -For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq). +For questions or assistance, contact the team on the [Discord channel](https://discord.gg/5kaErDKDRq). diff --git a/docs/website/blog/2024-10-15-cardano-stake-distribution-certification.md b/docs/website/blog/2024-10-15-cardano-stake-distribution-certification.md index 4b9d4a6292b..da960df6e25 100644 --- a/docs/website/blog/2024-10-15-cardano-stake-distribution-certification.md +++ b/docs/website/blog/2024-10-15-cardano-stake-distribution-certification.md @@ -9,30 +9,30 @@ tags: [certification, cardano stake distribution] :::info Update 2024/10/21 -We have shipped stable support for the **Cardano stake distribution certification** with distributions [2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1) and [2442](https://github.com/input-output-hk/mithril/releases/tag/2442.0). +We have released stable support for the **Cardano stake distribution certification** with distributions [2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1) and [2442](https://github.com/input-output-hk/mithril/releases/tag/2442.0). -A threshold of at least **70%** of the stake running version `0.2.182` (within **10** days after the distribution `2442` is released) is mandatory in order to activate the certification of the Cardano stake distribution on the `release-mainnet` network. +A threshold of at least **70%** of the stake running version `0.2.182` (within **10** days after the distribution `2442` is released) is mandatory to activate the certification of the Cardano stake distribution on the `release-mainnet` network. The [Mithril Protocol Insights](https://lookerstudio.google.com/s/mbL23-8gibI) dashboard displays the adoption rate of the different signer versions on the `release-mainnet` network. ::: -With the release of the new distribution [2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1), we have started to roll-out the certification of the **Cardano stake distribution** in the Mithril networks. +With the release of the new distribution [2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1), we have started to roll out the certification of the **Cardano stake distribution** in the Mithril networks. The Mithril network now provides certified Cardano stake distribution data without requiring a full Cardano node, a useful feature for applications such as bridges and layer 2 solutions. The key features include: -- Certification of the Cardano stake distribution of the ending epoch at each epoch transition. -- New HTTP routes in the Aggregator REST API to access this certified data. -- Updates to the Mithril client library and CLI for retrieving and verifying Cardano stake distribution. -- WASM client support for these functionalities. +- Certification of the Cardano stake distribution of the ending epoch at each epoch transition +- New HTTP routes in the aggregator REST API to access this certified data +- Updates to the Mithril client library and CLI for retrieving and verifying Cardano stake distribution +- WASM client support for these functionalities - Mithril Explorer now displays certified Cardano stake distribution. The roll-out plan of the feature is the following: - [x] Distribution [2437](https://github.com/input-output-hk/mithril/releases/tag/2437.1): - - [x] Activation of the certification of **Cardano stake distribution** in the `pre-release-preview` network. - - [x] Activation of the certification of **Cardano stake distribution** in the `release-preprod` network. + - [x] Activation of the certification of **Cardano stake distribution** in the `pre-release-preview` network + - [x] Activation of the certification of **Cardano stake distribution** in the `release-preprod` network - [x] Distribution [2442](https://github.com/input-output-hk/mithril/releases/tag/2442.0): - [ ] Activation of the certification of **Cardano stake distribution** in the `release-mainnet` network. -For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq). +For any inquiries or assistance, don't hesitate to contact the team on the [Discord channel](https://discord.gg/5kaErDKDRq). diff --git a/docs/website/blog/2024-11-07-mithril-aggregator-prometheus-endpoint/index.md b/docs/website/blog/2024-11-07-mithril-aggregator-prometheus-endpoint/index.md index 3629f6a3437..9dc798cbd88 100644 --- a/docs/website/blog/2024-11-07-mithril-aggregator-prometheus-endpoint/index.md +++ b/docs/website/blog/2024-11-07-mithril-aggregator-prometheus-endpoint/index.md @@ -7,12 +7,12 @@ tags: [mithril aggregator, metrics, Prometheus, Grafana] ### Mithril aggregator Prometheus endpoint is available -With the release of the new distribution [2445](https://github.com/input-output-hk/mithril/releases/tag/2445.0), the Mithril aggregator can start an optional Prometheus endpoint to monitor basic metrics. +With the release of [distribution 2445](https://github.com/input-output-hk/mithril/releases/tag/2445.0), the Mithril aggregator now includes an optional Prometheus endpoint for monitoring basic metrics. -Please note that the Mithril aggregator needs to be restarted after the configuration for the Prometheus endpoint. +After configuring the Prometheus endpoint, remember to restart the Mithril aggregator for the changes to take effect. -Additionally, a **Grafana template** has been created to easily setup a dashboard for this Prometheus endpoint (ID 22165): https://grafana.com/grafana/dashboards/22165-mithril-aggregator/ +To make setup easier, a **Grafana template** is available for creating a dashboard to visualize metrics from the Prometheus endpoint (ID 22165): [Grafana dashboard](https://grafana.com/grafana/dashboards/22165-mithril-aggregator/). -[![Grafana Dashboard](img/grafana-dashboard.png)](img/grafana-dashboard.png) +[![Grafana dashboard](img/grafana-dashboard.png)](img/grafana-dashboard.png) -For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq). +For questions or support, feel free to contact the team on the [Discord channel](https://discord.gg/5kaErDKDRq). diff --git a/docs/website/blog/2024-11-18-new-protocol-insights-dashboard/index.md b/docs/website/blog/2024-11-18-new-protocol-insights-dashboard/index.md index ed23b284929..77fb4caa56a 100644 --- a/docs/website/blog/2024-11-18-new-protocol-insights-dashboard/index.md +++ b/docs/website/blog/2024-11-18-new-protocol-insights-dashboard/index.md @@ -7,7 +7,7 @@ tags: [protocol, metrics, dashboard, insights] ### A new Protocol Insights Dashboard has been released -We have released a new version of the [**Protocol Insights Dashboard**](https://lookerstudio.google.com/s/mbL23-8gibI) which provides a comprehensive view of the Mithril network and its performance metrics. +We have released a new version of the [**Protocol Insights Dashboard**](https://lookerstudio.google.com/s/mbL23-8gibI), which provides a comprehensive view of the Mithril network and its performance metrics. The **Protocol Insights Dashboard** is a valuable tool for monitoring the network and understanding its behavior: @@ -15,8 +15,8 @@ The **Protocol Insights Dashboard** is a valuable tool for monitoring the networ - Usage metrics - Health metrics - Artifacts metrics -- Software metrics +- Software metrics. [![Protocol Insights Dashboard](img/protocol-insights-dashboard.gif)](img/protocol-insights-dashboard.gif) -For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq). +For any inquiries or assistance, don't hesitate to contact the team on the [Discord channel](https://discord.gg/5kaErDKDRq). diff --git a/docs/website/blog/2024-11-25-one-line-binaries-installer.md b/docs/website/blog/2024-11-25-one-line-binaries-installer.md index 56a5d21d6f7..4f7f9f365ef 100644 --- a/docs/website/blog/2024-11-25-one-line-binaries-installer.md +++ b/docs/website/blog/2024-11-25-one-line-binaries-installer.md @@ -17,12 +17,11 @@ tags: ### One line installer for Mithril binaries -In order to facilitate the installation and update of Mithril binaries, we have created a one line installer that downloads and installs the Mithril binaries for you. -This installer is available for Linux and MacOS, and for the Mithril signer, Mithril aggregator, and Mithril CLI. +To simplify the installation and updating of Mithril binaries, we have created a one line installer that downloads and installs the Mithril binaries for you. This installer is available for Linux and macOS and supports the Mithril signer, Mithril aggregator, and Mithril client CLI. -The one line command is also displayed in the several `Download the pre-built binary` sections across the documentation. +The one line command is also displayed in the various `Download the pre-built binary` sections across the documentation. -Here are few examples of the one line installer: +#### Examples of the one line installer - Download the **latest Mithril signer** in the current directory: @@ -48,7 +47,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-out curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c mithril-client -d 2445.0 -p $(pwd) ``` -- Installer usage: +#### Installer usage ```bash curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -h @@ -61,4 +60,4 @@ Usage: sh [-n node] [-v version] [-d distribution] [-p path] ``` -For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq). +For any inquiries or assistance, feel free to contact the team on the [Discord channel](https://discord.gg/5kaErDKDRq).