docs(provider): add usage examples to provider README #2313
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VolodymyrBg
requested review from
DaniPopes,
mattsse,
klkvr and
yash-atreya
as code owners
mattsse
reviewed
Apr 18, 2025
There was a problem hiding this comment.
@yash-atreya should we do this, given that we already have this in the book?
crates/provider/README.md
Outdated
| use alloy_primitives::Address; | ||
|
|
||
| #[tokio::main] | ||
| async fn main() -> anyhow::Result<()> { |
There was a problem hiding this comment.
this should juse just Box<dyn Error> here
I don't think it makes sense, I would just link to the book instead |
jenpaff
requested changes
Apr 19, 2025
There was a problem hiding this comment.
We're currently in the process of updating the alloy book https://alloy.rs/ , we should link to the examples in the book.
Like this? or in the book repository? |
mattsse
approved these changes
May 13, 2025
jgomez360
pushed a commit
to jgomez360/alloy
that referenced
this pull request
Jun 15, 2025
* docs(provider): add usage examples to provider README * Update README.md * Update README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The provider README.md file contained a TODO placeholder in the usage section without any actual examples. This made it difficult for new users to understand how to use the alloy-provider crate effectively. Clear documentation with usage examples is essential for developer adoption and understanding of the library's capabilities.
Solution
Added comprehensive usage examples to the provider README.md file, replacing the "TODO :)" with actual code samples. The examples demonstrate:
These examples cover the most common use cases and provide a good starting point for users of the alloy-provider crate.
PR Checklist