cfmms-rs icon indicating copy to clipboard operation
cfmms-rs copied to clipboard

Published 20 hours ago • verified publisher icon 0xKitsune

CFFM book

Open 0xKitsune opened this issue 2 years ago • 5 comments

Opening this issue to start brainstorming around what the CFFM book might look like. I think the book should look something like the Foundry book, walking through the different mods in the lib and how to use them.

0xKitsune avatar Dec 12 '22 16:12 0xKitsune

I'm down to start working on this 👀, not sure if this would be best separated into another repo or not.. probably?

0xOsiris avatar Dec 14 '22 03:12 0xOsiris

I think we can keep it in the same repo, in a book directory. That way, anyone can launch the book with mdbook serve --open after cloning the repo. Feel free to start a branch for the book and create a draft PR, we can brainstorm about the layout/content there.

0xKitsune avatar Dec 14 '22 03:12 0xKitsune

SGTM :p

0xOsiris avatar Dec 14 '22 03:12 0xOsiris

What are the benefits of using a book format as opposed to a more crate docs format?

e.g. https://doc.rust-lang.org/cargo/commands/cargo-doc.html

Evan-Kim2028 avatar May 15 '23 23:05 Evan-Kim2028