Foundry cheatsheet -> Foundry book

[dabit3]

I spoke with @gakonst about merging the Foundry Cheatsheet into Foundry Book.

I put this repo together to have a more concise one-page overview of some of the things I was using the most, and many people ended up finding it helpful.

But it makes more sense not to have it separate from the rest of the learning material in Foundry Book, as to have less fragmentation.

I wanted to know what you all think of adding this to the Foundry book, and if so where you might think it should go?

Thanksk

[skaunov]

Personally I well comfortable with reference guide since there one-pagers for anvil, forge, and cast.

But if there will be also a cheatsheet I would use Solidity experience, and placed it more or less like they had.

On Sat, Jul 30 2022 at 05:34:30 AM -0700, Nader Dabit @.***> wrote:

I spoke with @gakonst https://github.com/gakonst about merging the Foundry Cheatsheet https://github.com/dabit3/foundry-cheatsheet into Foundry Book.

I put this repo together to have a more concise one-page overview of some of the things I was using the most, and many people ended up finding it helpful.

But it makes more sense not to have it separate from the rest of the learning material in Foundry Book, as to have less fragmentation.

I wanted to know what you all think of adding this to the Foundry book, and if so where you might think it should go?

Thanksk

— Reply to this email directly, view it on GitHub https://github.com/foundry-rs/book/issues/489, or unsubscribe https://github.com/notifications/unsubscribe-auth/APXLOT25OY2Z3RHWU27G4HDVWUONNANCNFSM55DFFP5Q. You are receiving this because you are subscribed to this thread.Message ID: @.***>

[Leutwiler]

In my opinion, we should add it to a new Appendix section. We could even write about the existence of the cheatsheet in the First Steps with Foundry section, so the reader would be knowledgeable about the cheatsheet right at the start of the book.

As you created the cheatsheet, I don't know if you personally want to add it to the Foundry Book, but if you don't mind I can do it for you! Just reply me about it so I can start :grinning:

[onbjerg]

I don't have super strong opinions about having it in or not. Multiple ways:

• An appendix section as suggested by @Leutwiler; in this case we should also see if some other sections fit better there
• A dedicated page in the references section
• A link to the cheatsheet + a callout in the getting started guide

In the first two cases we probably need to reformat it a bit so it fits better with the book

[gakonst]

I'd maybe restructure the book so that the cheatsheet comes first in the intro, and then links out to the other sections to get more granular?

[dabit3]

@gakonst can I submit a PR to get this rolling? from there, we can discuss any changes. Just lmk.

[gakonst]

Yep go for it - trust your judgment, also wouldn't be afraid of refactoring/reordering things already in the book