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.

Sign up for GitHub

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

Jump to bottom

x/pkgsite: links in README.md are having the #anchor stripped so don't link to a subsection of the external doc #59826

Open

TristanSpeakEasy opened this issue Apr 25, 2023 · 0 comments

Labels

NeedsInvestigation pkgsite

Milestone

pkgsite/backlog

TristanSpeakEasy commented Apr 25, 2023

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/speakeasy-api/speakeasy-client-sdk-go#section-readme

What is your user agent?

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36

Screenshot

What did you do?

Clicking any of the links in the render Readme section of the pkg.go.dev page for a module, will take you to a link for example https://github.com/speakeasy-api/speakeasy-client-sdk-go/blob/v1.15.1/docs/apiendpoints/README.md which is missing the anchor that was originally in the README.md ie https://github.com/speakeasy-api/speakeasy-client-sdk-go/blob/v1.15.1/docs/apiendpoints/README.md#findapiendpoint

What did you expect to see?

That anchor's are retained when rendering the links in the readme section.

What did you see instead?

The anchors are removed and there for the links don't link to the same place as the original markdown links

TristanSpeakEasy added the pkgsite label

gopherbot added this to the Unreleased milestone

jamalc modified the milestones: Unreleased, pkgsite/later

jamalc added the NeedsInvestigation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment