go.dev: include '露' permalinks in all package doc subheadings

Created on 27 Jan 2020  路  5Comments  路  Source: golang/go

What is the URL of the page with the issue?

https://pkg.go.dev/testing?tab=doc

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.66 Safari/537.36

Screenshot

Screen Shot 2020-01-27 at 19 12 01

What did you do?

Tried to link to the "Benchmarks" subsection of the testing package docs.

What did you expect to see?

Each subheading to be a link such that hovering over it (the heading) a symbol should appear, like on godoc:

Screen Shot 2020-01-27 at 19 12 17

Clicking that link should then change to the address bar URL to include the fragment. For example on godoc, for the "Benchmarks" subsection we end up with the URL:

https://godoc.org/testing#hdr-Benchmarks

What did you see instead?

No ability to link to subsections of package documentation.

FeatureRequest NeedsFix pkgsite

Most helpful comment

This fix has been deployed and it's working as expected. For example, see:

image

Note that it may not appear on some existing package versions until they've been reprocessed, but they should work on all new versions. Please let us know if you spot any other issues.

All 5 comments

Would you mind clarifying if you are able to link subsections today using the same URL scheme from godoc.org? For example:

https://pkg.go.dev/testing?tab=doc#hdr-Benchmarks

takes me to:
image

My understanding is that this issue is specifically asking to add a clickable symbol next to each subheading.

/cc @dmitshur

@julieqiu

Would you mind clarifying if you are able to link subsections today using the same URL scheme from godoc.org?

As you demonstrated, that appears to work (not that I had tried)

My understanding is that this issue is specifically asking to add a clickable 露 symbol next to each subheading.

Exactly, as per the original description:

_Each subheading to be a link such that hovering over it (the heading) a 露 symbol should appear, like on godoc:_

_Clicking that link should then change to the address bar URL to include the fragment. For example on godoc, for the "Benchmarks" subsection we end up with the URL:_

I've sent a CL that should fix this issue once it is deployed. We can keep this issue open to confirm everything is working as expected.

This is super important, thank you @dmitshur !

This fix has been deployed and it's working as expected. For example, see:

image

Note that it may not appear on some existing package versions until they've been reprocessed, but they should work on all new versions. Please let us know if you spot any other issues.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ianlancetaylor picture ianlancetaylor  路  138Comments

chai2010 picture chai2010  路  216Comments

tklauser picture tklauser  路  219Comments

networkimprov picture networkimprov  路  194Comments

bradfitz picture bradfitz  路  151Comments