Re: Team "book"

[Matthias Geiger <werdahias@riseup.net>]

On 13.07.24 06: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/
I fear that having *one* ultimate source of truth is just not possible. 
I am not against having a book; maybe we can "liberate" the main repo a 
bit ?

FWIW, I wrote the rust_hacks.md to collect common gotchas I couldn't 
remember all at once. A draft for packaging cdylibs is also on my drive.

I think such specific / detailed instructions should be moved there.


best,


werdahias