ethereumjs-monorepo icon indicating copy to clipboard operation
ethereumjs-monorepo copied to clipboard

Clean up the docs

Open acolytec3 opened this issue 8 months ago • 3 comments

Before we publish our final set of releases, we should do a general docs overhaul

Currently, we have:

  • DEVELOPER.md in multiple packages (might still make sense but we should review)
  • E2E_TESTING.md, MONOREPO.md, and README.md in the config directory that should be consolidated and/or relocated (maybe to repo root). These have lots of obsolete references in them like verdaccio which we no longer use
  • An out of date mermaid relationship diagram in README.md in the repo root. We should maybe add era, verkle, and binarytree here

I'm sure there's more.

acolytec3 avatar Mar 28 '25 15:03 acolytec3

can i work on it

anushkasomani avatar Mar 29 '25 12:03 anushkasomani

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.

acolytec3 avatar Mar 31 '25 18:03 acolytec3

Our discord: https://discord.gg/TNwARpR 😄 👍

jochem-brouwer avatar Mar 31 '25 18:03 jochem-brouwer