[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Team "book"



Hi team,

In last meeting we agreed the team could use some improvements on docs.
Expanding on that, I think we can take a form common in the Rust ecosystem, that
is, writing a "book". On the language level there are [TRPL], [RBE], cargo,
rustc, and many more; many crates also have their own "books", incl. but not
limited to time, async-std, pest, criterion. They all use mdBook.

Benefits include:

- Better organized and presented
- Single source of truth and entry point, nicer to outside contributors
- Version controlled with Git (usually)
- Easily published through salsa, to e.g. rust-team.pages.debian/book/

mdBook isn't in Debian yet but I've done the packaging.

TRPL: The Rust Programming Language, https://doc.rust-lang.org/book/
RBE: https://doc.rust-lang.org/rust-by-example/

-- 
Sdrager,
Blair Noctis

Attachment: OpenPGP_0xC21D9AD423A39727.asc
Description: OpenPGP public key

Attachment: OpenPGP_signature.asc
Description: OpenPGP digital signature


Reply to: