crates.io VS docs.rs

So, be sure to double-check your critical libraries and be sure their alternatives exist in the Rust ecosystem. There’s a good chance the crates you need are available in Rust's crates.io repository.

The previous section was very simple, this section is also very simple but introduces us to cargo which is Rust's package manager, as a JS dev my mind goes straight to NPM.

Now, there has to be a place where all these packages come from. Similar to npmjs registry, where all node packages are registered, stored and retrieved, Rust also has something called crates.io where many helpful packages and dependencies are registered.

Before proceeding, let's check https://crates.io/, the official Rust package registry.

The most thrilling aspect has been the joy of writing the backend. It's like every struct, enum, and method in Rust forms this interconnected Multiverse of code , which you can see in crates.io which is best Documentation experience I Ever Had.

5. Crates.io

When using crates from eg. crates.io, and also things like std and core

Vendoring your packages was very tedious to even remotely get to work with Cargo. I spent a very long time getting Cargo to work together with cargo-local-registry. We vendor crates from crates.io and a custom internal registry.

So this is my question: Which way was the right to find it out? There is no info about this feature on crates.io. I also have no clue what exactly it does and why it is named rwh_05.

Rust does it so much better with https://crates.io . I don't know why Go can't (or won't) do something similar.

Working in combination with CodeWhisperer in your IDE, you can send whole code sections to Amazon Q and ask for an explanation of what the selected code does. To show how this works, we open up the file.rs file cloned from this GitHub repository. This is part of an open source project to host documentation of crates for the Rust Programming Language, which is a language we are not familiar with.

Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

Rust Search Extension adds a section on docs.rs menubar which lists the features of a crate in a nice and easy to access format.

📝 Note: At the time of writing this post, I couldn't really locate the init function docs.rs documentation. It didn't seem easily accessible through any of the current HAL implementation documentation. Nevertheless, I reached the signature of the function through the source here.

Rust Crates are a Game-Changer 🎮:The ease of releasing a crate with `cargo publish` and the convenience of rolling out new versions amazed me. The auto-generated docs on Docs.rs. is an amazing tool, especially with docstring formatting. Doc tests serve as a two-fold tool for documenting the code and ensuring it's up-to-date.

I've found I manually type out certain subsets of URLs where possible[0], maybe that's subconsciously associated with my impression that Google Search results have gotten worse and worse over the years.

[0] https://en.wiktionary.org/wiki/ and https://docs.rs/ come to mind.

docs.rs also downloads you crate automatically to generate docs and I would guess lib.rs does something similar

There are also a few key sites you'll want to keep in your back pocket at all times: - The Standard Library Documentation has complete documentation for every std library function in Rust - crates.io is a repository for all third-party packages, and docs.rs has human-readable documentation for the overwhelming majority of them - The Rust Cookbook has some code examples for common tasks you may need to perform - Make sure you are using clippy, which is available through Rustup and can be run with cargo clippy as a replacement to cargo check, it adds additional lints for your Rust code and is very helpful for teaching many of the best practices

OTOH, source-code-generated-docs normalize how code docs are, like the rust docs.rs paradigm, so it sort of forces or encourages package creators/maintainers to write docs.