Skip to content

Commit

Permalink
chore(docs): Remove op-alloy-protocol from docs (#380)
Browse files Browse the repository at this point in the history
- Removes `op-alloy-protocol` from docs. Ref
#371.
- Updates issue template to reflect removed crates
#372,
#376
  • Loading branch information
emhane authored Jan 13, 2025
1 parent 738442d commit 2ca30da
Show file tree
Hide file tree
Showing 17 changed files with 10 additions and 691 deletions.
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/FEATURE-FORM.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,8 @@ body:
- consensus
- network
- genesis
- protocol
- provider
- op-alloy
- registry
- rpc-jsonrpsee
- rpc-types
- rpc-types-engine
- other
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ shall be dual licensed as above, without any additional terms or conditions.

[check-no-std]: ./scripts/check_no_std.sh

[kona]: https://github.com/anton-rs/kona
[kona]: https://github.com/op-rs/kona
[alloy]: https://github.com/alloy-rs/alloy
[contributing]: https://alloy-rs.github.io/op-alloy

Expand Down
8 changes: 0 additions & 8 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,8 @@
- [System Config](./building/genesis/system-config.md)
- [Consensus](./building/consensus.md)
- [Engine RPC Types](./building/engine.md)
- [Protocol](./building/protocol/README.md)
- [BlockInfo and L2BlockInfo Types](./building/protocol/block-info.md)
- [Frames](./building/protocol/frames.md)
- [Channels](./building/protocol/channels.md)
- [Batches](./building/protocol/batches.md)
- [Examples](./examples/README.md)
- [Load a Rollup Config](./examples/load-a-rollup-config.md)
- [Create a new L1BlockInfoTx Hardfork Variant](./examples/new-l1-block-info-tx-hardfork.md)
- [Transform Frames to a Batch](./examples/frames-to-batch.md)
- [Transform a Batch into Frames](./examples/batch-to-frames.md)
- [Contributing](./CONTRIBUTING.md)
- [Licensing](./LICENSE.md)
- [Glossary](./glossary.md)
7 changes: 0 additions & 7 deletions book/src/building/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Some of the primary crates and their types are listed below.
- [`op-alloy-rpc-types-engine`][op-alloy-rpc-types-engine] provides the
[`OpPayloadAttributes`][op-payload-attributes] and
[`OpAttributesWithParent`][op-attributes-with-parent].
- [`op-alloy-protocol`][op-alloy-protocol] provides [`Frame`][frame],
[`Channel`][channel], [`Batch`][batch] types and more.


<!-- Links -->
Expand All @@ -28,11 +26,6 @@ Some of the primary crates and their types are listed below.
[op-payload-attributes]: https://docs.rs/op-alloy-rpc-types-engine/latest/op_alloy_rpc_types_engine/struct.OpPayloadAttributes.html
[op-attributes-with-parent]: https://docs.rs/op-alloy-rpc-types-engine/latest/op_alloy_rpc_types_engine/struct.OpAttributesWithParent.html

[frame]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/struct.Frame.html
[channel]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/struct.Channel.html
[batch]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/enum.Batch.html

[op-alloy-genesis]: https://crates.io/crates/op-alloy-genesis
[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus
[op-alloy-protocol]: https://crates.io/crates/op-alloy-protocol
[op-alloy-rpc-types-engine]: https://crates.io/crates/op-alloy-rpc-types-engine
66 changes: 0 additions & 66 deletions book/src/building/protocol/README.md

This file was deleted.

117 changes: 0 additions & 117 deletions book/src/building/protocol/batches.md

This file was deleted.

27 changes: 0 additions & 27 deletions book/src/building/protocol/block-info.md

This file was deleted.

109 changes: 0 additions & 109 deletions book/src/building/protocol/channels.md

This file was deleted.

Loading

0 comments on commit 2ca30da

Please sign in to comment.