Skip to content

Remove old, unsupported documentation #4489

Open
@fulldecent

Description

@fulldecent

Problem:

Search Google for Ethers.js documentation.

Expected: clicking any result on the first page is helpful.

Actual: clicking any result on the first page goes to old documentation (v5) AND there is no indication that there is a newer version!

Recommendations

  • Update the /v5/ documentation to link to /v6/.

    I wasted a lot of time implementing v5 and not knowing that v6 existed because the current Ethers README points to v5 documentation and the v5 says nothing of v6.

  • Publish the latest documentation to the URL https://docs.ethers.org without a /v6/ qualifier.

    For example, Ethereum.org/..., Ethers' own documentation, countless tutorials across the web all link to old versions

    This fixes the problem going forward.

  • Unpublish v4 and all earlier documentation. Only publish supported versions. If people need the old versions (they shouldn't), they can compile from repo history.

    • Remove links to those deleted web pages
  • Remove link to old documentation in https://ethers.org/ it's in the playground (probably better to delete that whole website)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation related issue.next-patchIssues scheduled for the next arch release.on-deckThis Enhancement or Bug is currently being worked on.v6Issues regarding v6

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions