Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

CFFM book #23

Open
0xKitsune opened this issue Dec 12, 2022 · 5 comments
Open

CFFM book #23

0xKitsune opened this issue Dec 12, 2022 · 5 comments

Comments

@0xKitsune
Copy link
Owner

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.

@0xOsiris
Copy link
Collaborator

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

@0xKitsune
Copy link
Owner Author

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.

@0xOsiris
Copy link
Collaborator

SGTM :p

@Evan-Kim2028
Copy link

Evan-Kim2028 commented May 15, 2023

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants
@0xOsiris @Evan-Kim2028 @0xKitsune and others