This repository has been archived by the owner on Oct 27, 2023. It is now read-only.
cookbook: Improve the introduction page #18
Closed
Conversation
This file contains 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
The license is at the bottom already, no need to force it down peoples throat.
Most devs know how to do the cargo stuff, its good to have but no need to be front and centre. Move the basic cargo stuff to its own page so as not to clutter the intro. While we move it, change the text to mention that "rand-std" is useful for playing around because one can generate keys. Production devs should probably know what they are doing with secrets anyways.
Make an attempt to improve the introduction by doing: - Explain the rust-bitcoin org/crate difference - Explicitly state that this book is about all org crates - Mention bdk and ldk - Mention that the book is WIP
|
@realeinherjar are you able/willing to review this one? If so we can test out the github action if/when it merges to see if we have things configured correctly now. |
realeinherjar
approved these changes
Oct 23, 2023
| ``` | ||
|
|
||
| If you are playing around you probably want to use the "rand-std" feature so you can generate random | ||
| keys while you do so. |
There was a problem hiding this comment.
Suggested change
| keys while you do so. | |
| keys: |
Less is more
| appreciated. It covers various crates from the org and as such, aims to be useful to developers | ||
| wanting to write code in Rust that interacts with the Bitcoin network. It is specifically not | ||
| limited to just the [`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) crate, although | ||
| that is a good starting point if you want a one stop shop for interacting with Bitcoin in Rust. |
There was a problem hiding this comment.
Suggested change
| that is a good starting point if you want a one stop shop for interacting with Bitcoin in Rust. | |
| that is a good starting point if you want a one-stop-shop for interacting with Bitcoin in Rust. |
Comment on lines
+10
to
+11
| There are a number of good libraries built outside of the `rust-bitcoin` organization that build on | ||
| top of the crates covered here, two that you might like to check out are: |
There was a problem hiding this comment.
Suggested change
| There are a number of good libraries built outside of the `rust-bitcoin` organization that build on | |
| top of the crates covered here, two that you might like to check out are: | |
| There are a number of good libraries outside of `rust-bitcoin` organization that uses the crates covered here, two that you might like to check out are: |
There was a problem hiding this comment.
Used:
There are a number of good libraries outside of the `rust-bitcoin` organization that use the crates
covered here, two that you might like to check out are:
| The book covers various topics, including receiving data over P2P, | ||
| parsing blocks and transactions, | ||
| and constructing and signing transactions. | ||
| Finally, this book is currently WIP but hopes to eventually cover various topics, including parsing |
There was a problem hiding this comment.
Suggested change
| Finally, this book is currently WIP but hopes to eventually cover various topics, including parsing | |
| Finally, this book is currently Work in Progress (WIP) but hopes to eventually cover various topics, including parsing |
Don't assume people know all TLAs
There was a problem hiding this comment.
Used:
Finally, this book is currently a work inn progress but hopes to eventually cover various topics,
including parsing blocks and transactions, constructing and signing transactions, receiving data
over the peer-to-peer network, plus fun stuff you can do with miniscript.
| parsing blocks and transactions, | ||
| and constructing and signing transactions. | ||
| Finally, this book is currently WIP but hopes to eventually cover various topics, including parsing | ||
| blocks and transactions, constructing and signing transactions, receiving data over P2P, plus fun |
There was a problem hiding this comment.
Suggested change
| blocks and transactions, constructing and signing transactions, receiving data over P2P, plus fun | |
| blocks and transactions, constructing and signing transactions, receiving data over Peer-to-Peer (P2P), plus fun |
TLAs
There was a problem hiding this comment.
thanks, covered above.
|
All good points, will work them in and re-spin. Thanks for the review! |
|
I'm a goose, this PR needs migrating over to https://github.com/rust-bitcoin/rust-bitcoin.github.io because we are going to archive this repo. |
|
Migrated to rust-bitcoin/rust-bitcoin.github.io#4 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Written language is hard, continued improvement is required and likely many iterations.
Attempt to improve the introduction page.