docs: Add a direct link for the crates.io page and documentation. #131
Conversation
README.md
Outdated
|
|
||
| ## Documentation | ||
|
|
||
| You can find detailed information about the library on its [crates.io page](https://crates.io/crates/bitcoinkernel). Or access its documentation directly via [Doc.rs](https://docs.rs/bitcoinkernel/latest/bitcoinkernel/). |
There was a problem hiding this comment.
Can you reword this:
You can find detailed information about the library on its
[crates.io](https://crates.io/crates/bitcoinkernel), or access its
documentation directly via
[doc.rs](https://docs.rs/bitcoinkernel/latest/bitcoinkernel/).
There was a problem hiding this comment.
Done in c43b99a
I also noticed some spaces between lines missing, caught by Zed. Do you mind if i apply the formatting ?
README.md
Outdated
|
|
||
| You can find detailed information about the library on its [crates.io page](https://crates.io/crates/bitcoinkernel). Or access its documentation directly via [Doc.rs](https://docs.rs/bitcoinkernel/latest/bitcoinkernel/). | ||
|
|
||
| You can also build locally the documentation with: |
There was a problem hiding this comment.
Is this actually useful to have to document in every rust crate? I think if you use cargo this should be easy to discover.
There was a problem hiding this comment.
Thanks for the fast response
IMHO its really helpfull to have a direct link to the documentation on the readme, that was the initial goal of the PR.
Im often looking for things in doc.rs/crates.io and github and i miss it.
I know these instructions sounds redundant for experienced users but its just an excuse to have these direct links.
Also, I have a little worry that one could try to fake a package/lib on crates.io or github so assuming explicitely these pages can bring more security that users will find the correct link specially for people who dont have that much experience with the rust ecosystem itself.
In the end... Yes! thats not too useful but its only 13 lines that can help a lot
There was a problem hiding this comment.
I think the links are great, but I don't want to clutter the README too much. Can you remove the examples for generating them?
There was a problem hiding this comment.
Removed local build instruction for docs in fe6ff60
2 participants
This PR add a direct link for the crates.io page and documentation.