From 3775c5f8d77a4dfa8dad4ba2260fa77425e4b068 Mon Sep 17 00:00:00 2001 From: ltitanb Date: Mon, 7 Oct 2024 17:05:58 +0100 Subject: [PATCH] typos --- docs/docs/developing/commit-module.md | 8 ++++---- docs/docs/get_started/running/binary.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/developing/commit-module.md b/docs/docs/developing/commit-module.md index 82b6f616..af47384e 100644 --- a/docs/docs/developing/commit-module.md +++ b/docs/docs/developing/commit-module.md @@ -4,7 +4,7 @@ sidebar_position: 2 # Commit Module -While a module can be written in any language, we currently provide some utils for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust. +While a module can be written in any language, we currently provide some utilities for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust. :::note Commit-Boost is still in alpha development, all APIs are subject to change @@ -25,7 +25,7 @@ use commit_boost::prelude::*; ## Config Your module will likely need a configuration for the Node Operator to customize. This will have to be in the `cb-config.toml` file, in the correct `[[module]]` section. In the module, you can define and load your config as follows. -First define all the parameters needed in a struct: +First, define all the parameters needed in a struct: ```rust #[derive(Debug, Deserialize)] struct ExtraConfig { @@ -109,7 +109,7 @@ You can use the `prometheus` crate to create a custom registry and metrics, for ```rust static ref MY_CUSTOM_REGISTRY: Registry = Registry::new_custom(Some("da_commit".to_string()), None).unwrap(); -static ref SIG_RECEIVED_COUNTER: IntCounter = IntCounter::new("signature_received", "successful signatures requests received").unwrap(); +static ref SIG_RECEIVED_COUNTER: IntCounter = IntCounter::new("signature_received", "successful signature requests received").unwrap(); ``` ### Start Metrics Provider @@ -125,4 +125,4 @@ All that is left is to use the metrics throughout your code: ```rust SIG_RECEIVED_COUNTER.inc(); ``` -These will automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running. \ No newline at end of file +These will be automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running. \ No newline at end of file diff --git a/docs/docs/get_started/running/binary.md b/docs/docs/get_started/running/binary.md index 28a22a6e..b86c8ffa 100644 --- a/docs/docs/get_started/running/binary.md +++ b/docs/docs/get_started/running/binary.md @@ -35,7 +35,7 @@ For loading keys we currently support: - `CB_MODULE_ID`: required, unique id of the module #### Commit modules -- `CB_SIGNER_URL`: requred, url to the signer module server +- `CB_SIGNER_URL`: required, url to the signer module server - `CB_SIGNER_JWT`: required, jwt to use to for signature requests (needs to match what is in `CB_JWTS`) #### Events modules