Skip to content
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.

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

x/pkgsite: add repository link on documentation page #39218

Open
tonglil opened this issue May 22, 2020 · 1 comment
Open

x/pkgsite: add repository link on documentation page #39218

tonglil opened this issue May 22, 2020 · 1 comment

Comments

@tonglil
Copy link

@tonglil tonglil commented May 22, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc
https://pkg.go.dev/github.com/sirupsen/logrus@v1.6.0?tab=doc
https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#AddHook

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:75.0) Gecko/20100101 Firefox/75.0

What is the issue?

There are no links to the github/source repository from the doc pages.
I don't want to click two clicks to go to the source:
gif

What did you expect to see?

  1. I want to be able to click on this to go to the source:

image

This is godoc.org's behavior when you click on the package name:

image

  1. I should also be able to click on any tag version to get to the source's tree of that version:

image

  1. I should be taken to the master branch when i click on the function reference, instead i am taken to a tagged version, even though I am on a "tagless" version of the doc site (https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#AddHook is not @Version).
    This is godoc.org's behavior.

What did you see instead?

  1. I can't click on it, need to copy and paste + hit enter.

  2. I can't click on it.

  3. I am taken to https://github.com/sirupsen/logrus/blob/v1.6.0/exported.go#L50 instead of https://github.com/sirupsen/logrus/blob/master/exported.go#L50

@gopherbot gopherbot added the pkgsite label May 22, 2020
@gopherbot gopherbot added this to the Unreleased milestone May 22, 2020
@tonglil
Copy link
Author

@tonglil tonglil commented May 22, 2020

Bonus

The static site banner covers links to examples:
gif

@julieqiu julieqiu changed the title go.dev: please give me links to the source go.dev: add repository link on documentation page Jun 1, 2020
@julieqiu julieqiu added UX and removed Documentation labels Jun 1, 2020
@julieqiu julieqiu changed the title go.dev: add repository link on documentation page x/pkgsite: add repository link on documentation page Jun 15, 2020
@julieqiu julieqiu removed the Documentation label Jun 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.