docs.rs VS book

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.

My first port of call was to google learn rust which lead me to "the book". The book is a first steps guide written by the rust community for newbies (or Rustlings as they're called) to gain a 'solid grasp of the language'.

Before Prodzilla, I’d read 'The Book' a couple of times, and had made my way through Rustlings, but hadn’t yet built a serious project in Rust.

To answer your last question;

Start with the Rust book.

https://doc.rust-lang.org/book/

Then do Rustlings until the syntax becomes muscle memory.

Then join the Discord and start doing little projects.

You won’t get up to the proficiency of other languages as quickly in Rust. It takes longer. For me it’s taking a lot longer, but I enjoy it.

Before diving into these repositories, familiarize yourself with Rust and its development ecosystem. The official Rust book is an excellent resource for developers at all levels. Each repository has documentation on how to contribute, covering code style, issue tracking, and pull requests.

This is my third Rust book after the official book and Rust in Action. The other two books are great, but they were too theoretical for me. I'm a slow learner and had much trouble grokking Rust's features and idiosyncrasies. When I was done with these books, I was lost and unsure of what I could do.

It's the same reason everything digital and downloadable isn't free: there's a cost to create it and there's a value to it.

For a language developer to charge for a book about that language, I think that's a completely valid way to make some money off of their work.

Even the Rust book, "The Rust Programming Language" is available freely online [0], but also as a print and ebook for sale via NoStarchPress [1].

[0] https://doc.rust-lang.org/book/

[1] https://nostarch.com/rust-programming-language-2nd-edition

You know you can just read it online right now in 2 different variants It does contain some systems programming.

I am looking at The Book (https://doc.rust-lang.org/book/), but hoped there was an amazing person on youtube.

Yeah, I'll build something, finally trying webassembly.

https://doc.rust-lang.org/book/ https://github.com/rust-lang/rustlings https://doc.rust-lang.org/rust-by-example/