-
Notifications
You must be signed in to change notification settings - Fork 18k
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/website: inconsistent layout between src and pkg #29585
Comments
The source viewer implements a breadcrumb structure where each link is clickable, signifying a directory hierarchy. But the package viewer just displays documentation about a package. And the name of the package is ecdsa. Showing pkg/crypto/ecdsa won't be accurate.
I am neutral to this. The source links are already there in the Package files section under index. That gives you the list of source files in the package. Not sure if adding a separate link to the package directory adds much value, since one has to click a source file anyways. Overall, I don't see an "inconsistency" between the layouts. Both of them serve different purposes and there is no need to conflate them. |
Understand your point of view to keep package as clean as possible but still feel and believe many others, that a header something like this is needed https://godoc.org/crypto/ecdsa If I would be the only one I don't believe godoc would implement this. |
I think this falls under the area of navigation: how to conveniently move from viewing documentation for package a to package b, especially when they're related (e.g., Having a header with clickable parent elements like at golang.org/src and on godoc.org is a reasonable way of doing this, and we may want to consider other approaches. There will be some UI changes done to godoc as part of adding support for module-aware mode (#26827) and consolidating UI features between gddo and x/tools/cmd/godoc (e.g., #27714). Let's keep this issue open, we can consider it when that work is being done. |
I don't think this is relevant anymore now that /pkg/ points to pkg.go.dev |
This is perfect

https://golang.org/src/crypto/ecdsa/ecdsa.go
Suggestion to make pkg layout more consistent with src by
a) use the same title link structure ( Package pkg/crypto/ecdsa )
b) adding a link to source with the same layout ( Source: crypto/ecdsa ) or
<a ref>
theimport "crypto/ecdsa"
line to the source codehttps://golang.org/pkg/crypto/ecdsa/

The text was updated successfully, but these errors were encountered: