Skip to content

Clean up the docs #3946

@acolytec3

Description

@acolytec3

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions