Conversation
emhane
added
K-docs
There was a problem hiding this comment.
Pull request overview
This PR replaces the comprehensive Reth README documentation with a preliminary version focused on op-reth historical proofs. The change aligns with the referenced issue #441 to create a more project-specific readme.
Key Changes:
- Replaced extensive Reth documentation (~150 lines) with a minimal README (~19 lines)
- Added new op-rs logo image asset
- Introduced placeholder sections for two new crates:
reth-optimism-trieandreth-optimism-exex
Reviewed changes
Copilot reviewed 1 out of 7 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Complete rewrite from Reth documentation to op-reth historical proofs overview with placeholder content marked as "Under Construction" |
| assets/op-rs-logo.png | New logo image added for the op-reth project |
| assets/reth*.png/jpg | Existing image assets (no changes shown in diff) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## An intro to `reth-optimism-trie` | ||
|
|
||
| ## Warning | ||
| ... |
There was a problem hiding this comment.
The content here is just "..." which is a placeholder. This section titled "An intro to reth-optimism-trie" should be filled in with actual documentation about this crate before merging.
|
|
||
| [book]: https://reth.rs/ | ||
| [tg-url]: https://t.me/paradigm_reth | ||
| ... No newline at end of file |
There was a problem hiding this comment.
The content here is just "..." which is a placeholder. This section titled "An intro to reth-optimism-exex" should be filled in with actual documentation about this crate before merging.
|
|
||
| > **Note** | ||
| # op-reth historical proofs | ||
|  |
There was a problem hiding this comment.
The alt text "Description" is generic and not descriptive. Consider using more specific alt text that describes the logo, such as "op-rs logo" or "OP Reth Historical Proofs logo".
|  | |
|  |
Ref #441 Add preliminary readme
Ref #441 Add preliminary readme
Ref #441 Add preliminary readme
Ref #441 Add preliminary readme
Ref #441 Add preliminary readme
Ref #441 Add preliminary readme
1 participant
Ref #441
Add preliminary readme