Skip to content

Commit

Permalink
add blob-archiver-rs doc
Browse files Browse the repository at this point in the history
  • Loading branch information
thinkAfCod committed Aug 24, 2024
1 parent 133a2f2 commit c4f9e3e
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@
],
"ignoreWords": [
"Hildr",
"Superproof",
"Shisui",
"Flashbots",
"meili",
"Linea"
]
Expand Down
24 changes: 24 additions & 0 deletions docs/blob-archiver-rs-docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# blob-archiver-rs
This is a Rust implementation of
the [Beacon Chain blob archiver](https://github.com/base-org/blob-archiver)

### Development
```sh
# Run the tests
cargo test --workspace --all-features --all-targets --locked

# Lint the project
cargo clippy --workspace --all-targets --all-features -- -D warnings

# Build the project
cargo build --workspace --all-targets --all-features

```

#### Run Locally
To run the project locally, you should first copy `.env.template` to `.env` and then modify the environment variables
to your beacon client and storage backend of choice. Then you can run the project with:

```sh
docker compose up
```
12 changes: 12 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,18 @@ const config = {
position: "left",
label: "Superproof",
},
{
type: "doc",
docId: "blob-archiver-rs-docs/index",
position: "left",
label: "Blob-arhiver-rs",
},
{
type: "doc",
docId: "blob-archiver-rs-docs/index",
position: "left",
label: "Blob-arhiver-rs",
},
{
href: "https://discord.gg/YC34UKyc2Y",
className: "header-discord-link",
Expand Down
3 changes: 3 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ const sidebars = {
],
},
],
blobArchiverRs: [
"blob-archiver-rs-docs/index",
],
};

module.exports = sidebars;

0 comments on commit c4f9e3e

Please sign in to comment.