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

Clean up the docs #3946

Open
acolytec3 opened this issue Mar 28, 2025 · 3 comments
Open

Clean up the docs #3946

acolytec3 opened this issue Mar 28, 2025 · 3 comments

Comments

@acolytec3
Copy link
Contributor

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.

@anushkasomani
Copy link

can i work on it

@acolytec3
Copy link
Contributor Author

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.

@jochem-brouwer
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants