rustc-dev-guide VS docs.rs

yes, it's possible! that list doesn't exist today but i would love to create it. i wrote a draft a few years ago before shifting to other work; someone recently expressed interest in reviving that project: https://github.com/rust-lang/rustc-dev-guide/pull/1463

<3 i'm glad you enjoyed it

It's possible - you could open an issue on the rustc-dev-guide repo if you'd like. https://github.com/rust-lang/rustc-dev-guide/

I'm very confident that this would be well received! I'm not sure where the source code for rustdoc lives, but I know that the internals getting started guide is here: https://github.com/rust-lang/rustc-dev-guide/blob/master/src/rustdoc.md. That would be a good place to start if you're looking into how the HTML is generated.

Do you have links to any good info about how much rustc reuses from previous runs? This is the first time i hear about reuse at the function level. I guess the rustc-dev-guide would be a good place for me to start?

Inspired by the rust compiler, you could represent the entire state of the application as a graph of operations with inputs and outputs. You can hash all the inputs and use that to memoize the operations, so that you don't have to repeat them, you can cache them in memory or on disk, and it helps you track which parts of the app state actually change between user operations and you can then be sure you put all the changes in the undo/redo stack, and so that you don't have to store duplicate copies of things that don't change. (How's that for a run-on sentence?) You could run a general binary diff algorithm between subsequent versions of the same operation with different inputs to try to reduce the memory used by storing the different versions, and have specialized diff algorithms for specific types of data. (How do you identify related operations? How much CPU does this use?) You can have a background task that compresses older versions with LZ4 or zstd. You can have a background task that saves older versions on-disk when there's memory pressure.

I contributed a couple small bugfixes for issues I ran into along the way as well. 1, 2

It's rustdoc: https://github.com/rust-lang/rustc-dev-guide/blob/master/src...

> Rustdoc actually uses the rustc internals directly. It lives in-tree with the compiler and standard library. This chapter is about how it works. For information about Rustdoc's features and how to use them, see the Rustdoc book. For more details about how rustdoc works, see the "Rustdoc internals" chapter.

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.