Skip to content

[Docs] Link to Go documentation references outdated documentation from 2018 #39761

@gtomitsuka

Description

@gtomitsuka

Describe the enhancement requested

The godoc format shows docs in a versioned fashion, making the "basic" link reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs.

Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong.

I have a PR for this (#39750), which is currently tagged as MINOR, but can't as this change will require tweaks to the release process. I'm creating this issue so I can update the .sh script in that PR and move it from a MINOR to regular PR.

Component(s)

Documentation

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions