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

meta: book revamp #943

Open
2 of 9 tasks
Evalir opened this issue Jul 4, 2023 · 0 comments
Open
2 of 9 tasks

meta: book revamp #943

Evalir opened this issue Jul 4, 2023 · 0 comments
Assignees
Labels
T-enhancement Type: enhance existing docs T-tracking Type: tracking issue

Comments

@Evalir
Copy link
Member

Evalir commented Jul 4, 2023

Tracking issue for the ongoing book revamp.

New tutorials

  • Making an ERC20 with Foundry
  • Deploying a proxy with Foundry
  • "Your first Foundry project" — and end to end, unit/invariant/fuzz/fork & deployment tutorial.
  • Migrating from Hardhat

Outline revamp

  • Move reference up to the front after guides / getting started for more visibility
  • Revamp overviews to showcase features, focus on feature discoverability
  • New Testing section decoupled from forge's outline
  • Move "integrating with hardhat" into a more front-and-center position

Misc (issues & things that don't fall in a particular category to fix, low-prio compared to above)

New outline order

  • Installation
  • Getting Started
  • Testing
  • Tutorials
    • Integrating with hardhat
  • Reference
  • Overviews
    • Forge
    • Cast
    • Anvil
    • Chisel
  • Appendix
@Evalir Evalir self-assigned this Jul 4, 2023
@Evalir Evalir added T-enhancement Type: enhance existing docs T-tracking Type: tracking issue labels Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-enhancement Type: enhance existing docs T-tracking Type: tracking issue
Projects
Status: Todo
Development

No branches or pull requests

2 participants
@Evalir and others