Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write FAQ #201

Closed
onbjerg opened this issue Apr 13, 2022 · 3 comments
Closed

Write FAQ #201

onbjerg opened this issue Apr 13, 2022 · 3 comments
Assignees
Labels
T-new Type: new docs

Comments

@onbjerg
Copy link
Member

onbjerg commented Apr 13, 2022

Some ideas for topics: foundry-rs/foundry#536

Various troubleshooting for installation (see the Foundry README).

Others would be common questions in the support Telegram.

@onbjerg onbjerg added the T-new Type: new docs label Apr 13, 2022
@onbjerg onbjerg moved this to Todo in Foundry Book Apr 13, 2022
@onbjerg
Copy link
Member Author

onbjerg commented Apr 13, 2022

Would it make sense to have #191 in the FAQ as well @mds1? Or would you like it in the DSTest reference? Not entirely sure what the best place is 😅

@mds1
Copy link
Contributor

mds1 commented Apr 13, 2022

Hmm, I think the FAQ probably makes more sense so it can include other related info. For example, the FAQ for #191 might also want to mention things like defining your vm and generic helper methods in that same DSTestPlus contract

Keeping the DSTest reference scoped to just test.sol seems nice, otherwise I can imagine some doc-creep on that page (though the DSTest reference currently has a "cheatcodes address" section which seems like it might be on the wrong page since that's not related to DSTest?)

@onbjerg onbjerg self-assigned this Apr 14, 2022
@onbjerg onbjerg moved this from Todo to In Progress in Foundry Book Apr 14, 2022
@onbjerg onbjerg moved this to Todo in Foundry Book Apr 14, 2022
@onbjerg onbjerg moved this from Todo to In Progress in Foundry Book Apr 14, 2022
@ZeroEkkusu
Copy link
Contributor

Some notes

  • The user should name their Vm instance in DSTestPlus something other than vm if they plan on using Forge Std (otherwise will conflict with the vm there)

Repository owner moved this from In Progress to Done in Foundry Book Apr 16, 2022
Repository owner moved this from In Progress to Done in Foundry Book Apr 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-new Type: new docs
Projects
No open projects
Status: Done
Development

No branches or pull requests

3 participants