chore(workspace): Touchup crate docs with badges (#309)

### Description Touches up crate documentation with badges.
alloy-rs · Nov 23, 2024 · 7ec5234 · 7ec5234
1 parent 8a38fc6
commit 7ec5234
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 28 deletions.
diff --git a/crates/consensus/README.md b/crates/consensus/README.md
@@ -1,6 +1,11 @@
-# op-alloy-consensus
+## `op-alloy-consensus`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-consensus"><img src="https://img.shields.io/crates/v/op-alloy-consensus.svg" alt="op-alloy-consensus crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Optimism consensus interface.
 
@@ -13,7 +18,7 @@ For consensus types that are not modified by the OP Stack, the `alloy-consensus`
 
 [deposit]: https://specs.optimism.io/protocol/deposits.html
 
-## Provenance
+### Provenance
 
 Much of this code was ported from [reth-primitives] as part of ongoing alloy migrations.
 

diff --git a/crates/genesis/README.md b/crates/genesis/README.md
@@ -1,10 +1,15 @@
-# op-alloy-genesis
+## `op-alloy-genesis`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-genesis"><img src="https://img.shields.io/crates/v/op-alloy-genesis.svg" alt="op-alloy-genesis crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Genesis types for Optimism.
 
-## Usage
+### Usage
 
 _By default, `op-alloy-genesis` enables both `std` and `serde` features._
 
@@ -15,15 +20,18 @@ If you're working in a `no_std` environment (like [`kona`][kona]), disable defau
 op-alloy-genesis = { version = "x.y.z", default-features = false, features = ["serde"] }
 ```
 
-[kona]: https://github.com/anton-rs/kona/blob/main/Cargo.toml#L137
-
 
-### Rollup Config
+#### Rollup Config
 
 `op-alloy-genesis` exports a `RollupConfig`, the primary genesis type for Optimism Consensus.
 
-## Provenance
+
+### Provenance
 
 This is based off of [alloy-genesis].
 
+
+<!-- Links -->
+
 [alloy-genesis]: https://github.com/alloy-rs
+[kona]: https://github.com/anton-rs/kona/blob/main/Cargo.toml#L137
diff --git a/crates/network/README.md b/crates/network/README.md
@@ -1,6 +1,11 @@
-# op-alloy-network
+## `op-alloy-network`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-network"><img src="https://img.shields.io/crates/v/op-alloy-network.svg" alt="op-alloy-network crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Optimism blockchain RPC behavior abstraction.
 

diff --git a/crates/op-alloy/README.md b/crates/op-alloy/README.md
@@ -1,27 +1,29 @@
-# `op-alloy`
+## `op-alloy`
 
 <a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
+<a href="https://crates.io/crates/op-alloy"><img src="https://img.shields.io/crates/v/op-alloy.svg" alt="op-alloy crate"></a>
 <a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
 <a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
 <a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
 
+
 Built on [Alloy][alloy], `op-alloy` connects applications to the OP Stack.
 
 
-## Usage
+### Usage
 
 To use `op-alloy`, add the crate as a dependency to a `Cargo.toml`.
 
 ```toml
 op-alloy = "0.6"
 ```
 
-## Development Status
+### Development Status
 
 `op-alloy` is currently in active development, and is not yet ready for use in production.
 
 
-## Supported Rust Versions (MSRV)
+### Supported Rust Versions (MSRV)
 
 The current MSRV (minimum supported rust version) is 1.81.
 
@@ -32,7 +34,7 @@ The MSRV is not increased automatically, and will be updated
 only as part of a patch (pre-1.0) or minor (post-1.0) release.
 
 
-## Contributing
+### Contributing
 
 op-alloy is built by open source contributors like you, thank you for improving the project!
 
@@ -42,7 +44,7 @@ Pull requests will not be merged unless CI passes, so please ensure that your co
 linting rules and passes clippy.
 
 
-## `no_std`
+### `no_std`
 
 op-alloy is intended to be `no_std` compatible, initially for use in [kona][kona].
 
@@ -59,14 +61,14 @@ If you would like to add no_std support to a crate,
 please make sure to update [scripts/check_no_std.sh][check-no-std].
 
 
-## Credits
+### Credits
 
 op-alloy is inspired by the work of several teams and projects, most notably [the Alloy project][alloy].
 
 This would not be possible without the hard work from open source contributors. Thank you.
 
 
-## License
+### License
 
 Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
 2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.

diff --git a/crates/protocol/README.md b/crates/protocol/README.md
@@ -1,12 +1,17 @@
-# op-alloy-protocol
+## `op-alloy-protocol`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-protocol"><img src="https://img.shields.io/crates/v/op-alloy-protocol.svg" alt="op-alloy-protocol crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Core protocol types for Optimism.
 
 These include types, constants, and methods for derivation as well as batch-submission.
 
-## Provenance
+### Provenance
 
 This code was initially ported from [kona-primitives] as part of ongoing op-alloy migrations.
 

diff --git a/crates/provider/README.md b/crates/provider/README.md
@@ -1,5 +1,10 @@
-# op-alloy-provider
+## `op-alloy-provider`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-provider"><img src="https://img.shields.io/crates/v/op-alloy-provider.svg" alt="op-alloy-provider crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Optimism providers to interface with APIs, namely the engine API.
diff --git a/crates/registry/README.md b/crates/registry/README.md
@@ -4,6 +4,7 @@
 <a href="https://crates.io/crates/op-alloy-registry"><img src="https://img.shields.io/crates/v/op-alloy-registry.svg?label=op-alloy-registry&labelColor=2a2f35" alt="op-alloy-registry"></a>
 <a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
 <a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
 
 
 [`op-alloy-registry`][sc] is a `no_std` crate that exports rust type definitions for chains
@@ -18,19 +19,20 @@ op-alloy-registry = "0.6.7"
 
 [`op-alloy-registry`][sc] declares lazy evaluated statics that expose `ChainConfig`s, `RollupConfig`s,
 and `Chain` objects for all chains with static definitions in the superchain registry. The way this works
-is the the golang side of the superchain registry contains an "internal code generation" script that has
+is the golang side of the superchain registry contains an "internal code generation" script that has
 been modified to output configuration files to the [`crates/registry`][s] directory in the
 `etc` folder that are read by the [`op-alloy-registry`][sc] rust crate. These static config files
-contain an up-to-date list of all superchain configurations with their chain configs.
+contain an up-to-date list of all superchain configurations with their chain configs. It is expected
+that if the commit hash of the [`superchain-registry`][osr] pulled in as a git submodule has breaking
+changes, the tests in this crate (`op-alloy-registry`) will break and updates will need to be made.
 
 There are three core statics exposed by the [`op-alloy-registry`][sc].
 - `CHAINS`: A list of chain objects containing the superchain metadata for this chain.
 - `OPCHAINS`: A map from chain id to `ChainConfig`.
 - `ROLLUP_CONFIGS`: A map from chain id to `RollupConfig`.
 
-While the [`op-alloy-genesis`][oag] crate contains a few hardcoded `RollupConfig` objects, the
-[`op-alloy-registry`][sc] exports the _complete_ list of superchains and their chain's `RollupConfig`s
-and `ChainConfig`s.
+[`op-alloy-registry`][sc] exports the _complete_ list of chains within the superchain, as well as each
+chain's `RollupConfig`s and `ChainConfig`s.
 
 
 ### Usage

diff --git a/crates/rpc-jsonrpsee/README.md b/crates/rpc-jsonrpsee/README.md
@@ -1,5 +1,10 @@
-# op-alloy-rpc-jsonrpsee
+## `op-alloy-rpc-jsonrpsee`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-rpc-jsonrpsee"><img src="https://img.shields.io/crates/v/op-alloy-rpc-jsonrpsee.svg" alt="op-alloy-rpc-jsonrpsee crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Low-level Optimism JSON-RPC server and client implementations.
diff --git a/crates/rpc-types-engine/README.md b/crates/rpc-types-engine/README.md
@@ -1,5 +1,10 @@
-# op-alloy-rpc-types-engine
+## `op-alloy-rpc-types-engine`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-rpc-types-engine"><img src="https://img.shields.io/crates/v/op-alloy-rpc-types-engine.svg" alt="op-alloy-rpc-types-engine crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Optimism RPC types for the `engine` namespace.
diff --git a/crates/rpc-types/README.md b/crates/rpc-types/README.md
@@ -1,5 +1,10 @@
-# op-alloy-rpc-types
+## `op-alloy-rpc-types`
 
+<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
 <a href="https://crates.io/crates/op-alloy-rpc-types"><img src="https://img.shields.io/crates/v/op-alloy-rpc-types.svg" alt="op-alloy-rpc-types crate"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a>
+<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a>
+<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
+
 
 Optimism RPC-related types.