Skip to content

Commit 67b9b0e

Browse files
DrewVanderWerffltitanb
authored andcommitted
chore: docs update (#202)
* Update troubleshooting.md * Update overview.md * Update commit-module.md * Update README.md * Update troubleshooting.md
1 parent cbf7f9b commit 67b9b0e

File tree

4 files changed

+3
-13
lines changed

4 files changed

+3
-13
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ For more information on how to run Commit-Boost, check out our [docs](https://co
2323
For more information on how to develop a module on Commit-Boost, check out our [docs](https://commit-boost.github.io/commit-boost-client/category/developing).
2424

2525
### Example
26-
> **_NOTE:_** The code is unaudited and NOT ready for production. All APIs are subject to change
2726

2827
A basic commit module with Commit-Boost.
2928

docs/docs/developing/commit-module.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ sidebar_position: 2
66

77
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.
88

9-
:::note
10-
Commit-Boost is still in alpha development, all APIs are subject to change
11-
:::
12-
13-
149
In Rust, we provide utilities to load and run modules. Simply add to your `Cargo.toml`:
1510
```toml
1611
commit-boost = { git = "https://github.com/Commit-Boost/commit-boost-client", rev = "..." }
@@ -125,4 +120,4 @@ All that is left is to use the metrics throughout your code:
125120
```rust
126121
SIG_RECEIVED_COUNTER.inc();
127122
```
128-
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.
123+
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.

docs/docs/get_started/overview.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ description: Initial setup
44

55
# Overview
66

7-
:::warning
8-
Commit-Boost is currently in alpha development and **NOT** ready for production use. Please use caution
9-
:::
10-
117
Commit-Boost is primarily based on [Docker](https://www.docker.com/) to enable modularity, sandboxing and cross-platform compatibility. It is also possible to run Commit-Boost [natively](/get_started/running/binary) without Docker.
128

139
Each component roughly maps to a container: from a single `.toml` config file, the node operator can specify which modules they want to run, and Commit-Boost takes care of spinning up the services and creating links between them.

docs/docs/get_started/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Common issues
44

55
# Troubleshooting
66

7-
Commit-Boost is currently in alpha development so it's likely there are bugs, if you find any or have any question, please reach out on [X (Twitter)](https://x.com/Commit_Boost) or [Telegram](https://t.me/+Pcs9bykxK3BiMzk5).
7+
Commit-Boost was recently audited and going through a phased approach for validators to move to production. If you find any or have any question, please reach out on [X (Twitter)](https://x.com/Commit_Boost) or [Telegram](https://t.me/+Pcs9bykxK3BiMzk5). If there are any security related items, please see [here](https://github.com/Commit-Boost/commit-boost-client/blob/main/SECURITY.md).
88

99

1010
If you started the modules correctly you should see the following logs.
@@ -65,4 +65,4 @@ This will only happen if you received a header in the previous call, and if the
6565
```bash
6666
2024-09-16T14:38:01.409075Z INFO submit_blinded_block{req_id=6eb9a04d-6f79-4295-823f-c054582b3599 slot=2549590}: ua="Lighthouse/v5.2.1-9e12c21" slot_uuid=16186e06-0cd0-47bc-9758-daa1b66eff5c ms_into_slot=1409 block_hash=0xfa135ae6f2bfb32b0a47368f93d69e0a2b3f8b855d917ec61d78e78779edaae6
6767
2024-09-16T14:38:02.910974Z INFO submit_blinded_block{req_id=6eb9a04d-6f79-4295-823f-c054582b3599 slot=2549590}: received unblinded block
68-
```
68+
```

0 commit comments

Comments
 (0)