ethereumjs-monorepo
ethereumjs-monorepo copied to clipboard
Clean up the docs
Before we publish our final set of releases, we should do a general docs overhaul
Currently, we have:
DEVELOPER.mdin multiple packages (might still make sense but we should review)E2E_TESTING.md,MONOREPO.md, andREADME.mdin theconfigdirectory that should be consolidated and/or relocated (maybe to repo root). These have lots of obsolete references in them likeverdacciowhich we no longer use- An out of date mermaid relationship diagram in
README.mdin the repo root. We should maybe addera,verkle, andbinarytreehere
I'm sure there's more.
can i work on it
can i work on it
This probably isn't a great issue for a first time contributor. One really needs to be familiar with the code base and have an understanding of what's changed over the past 1-2 years to be able to meaningfully contribute to this work.
If you're interested in contributing in general, join our discord and we can think through some issues that might be a better fit.
Our discord: https://discord.gg/TNwARpR 😄 👍