Documentation in the Rust Ecosystem
summary
Claims that Rust has great tooling but spotty crate docs get backed by a survey of the top 100 crates showing only about half with good API coverage, and by a case study: a Rust FAQ built over four months with 100 initial questions, 416 comments, 42 commits and 29 participants. The ecosystem ships rustdoc with the compiler, discusses doc types like meet-cute and black triangle, and shows concrete fixes: mentored issues, doc sprints, and treating doc contributors as full contributors.
AI-written summary · about
chapters (11)
- 0:00Start
- 1:11THE MEET CUTE THE BLACK TRIANGLE THE WALKTHROUGH THE REFERENCE
- 1:37WHAT IS THIS?" "WHY SHOULD I CARE?
- 2:11THE SIMPLEST CODE TO DO SOMETHING GOOD
- 4:39DOCS ARE THE FIRST THING PEOPLE SEE
- 9:30THE FIRST DRAFT
- 9:53YOU DON'T NEED TO KNOW EVERYTHING
- 11:57DON'T FEAR THE DELETE KEY
- 17:03BUT THERE'S ROOM FOR IMPROVEMENT
- 17:21LOTS OF DOCS ARE INCOMPLETE
- 17:38LOTS OF DOCS DON'T EXPLAIN ENOUGH
related talks
25mAugmented docs: a love letter to rustdoc and docs.rs
25mLessons Learned From the Rust Ecosystem That Can Be Adopted Elsewhere
31mThe Dark Secrets Lurking Inside cargo doc
28m"This Week in Rust: Ten Years of Learning Together"
25m"Compiler-Driven Development: Making Rust Work for You"
01h 02m“How to Write Effective Documentation for C++ Libraries..."
01h 42mIntroduction to Rust (for people who have never used a compiler)
24mEscaping the Curse of Outdated Docs