On 13/07/2024 12:30, Blair Noctis wrote: > 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/ Team, Some of the basic team documents have been "migrated" into the "book", namely the team policy, debcargo-conf README, and rust_hacks.md. You can already have a taste at https://rust-team.pages.debian.net/book/. Although salsa isn't running exactly smoothly these days, so please be patient if it goes 502. Keep in mind this is largely a WIP, to improve it needs your help. The source is at https://salsa.debian.org/rust-team/book. -- Sdrager, Blair Noctis
Attachment:
OpenPGP_signature.asc
Description: OpenPGP digital signature