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/website: inconsistent layout between src and pkg #29585

Closed
gertcuykens opened this issue Jan 6, 2019 · 5 comments
Closed

x/website: inconsistent layout between src and pkg #29585

gertcuykens opened this issue Jan 6, 2019 · 5 comments
Labels
FeatureRequest FrozenDueToAge NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Milestone

Comments

@gertcuykens
Copy link
Contributor

gertcuykens commented Jan 6, 2019

This is perfect
https://golang.org/src/crypto/ecdsa/ecdsa.go
image

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> the import "crypto/ecdsa" line to the source code

https://golang.org/pkg/crypto/ecdsa/
image

@julieqiu julieqiu changed the title website: inconsistent layout between src and pkg x/website: inconsistent layout between src and pkg Jan 7, 2019
@gopherbot gopherbot added this to the Unreleased milestone Jan 7, 2019
@julieqiu
Copy link
Member

julieqiu commented Jan 7, 2019

/cc @dmitshur @andybons

@agnivade
Copy link
Contributor

a) use the same title link structure ( Package pkg/crypto/ecdsa )

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.

b) adding a link to source with the same layout ( Source: crypto/ecdsa ) or <a ref> the import "crypto/ecdsa" line to the source code

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.

@agnivade agnivade added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Feb 25, 2019
@gertcuykens
Copy link
Contributor Author

gertcuykens commented Feb 26, 2019

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.

image

@dmitshur
Copy link
Contributor

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., crypto/ecdsa and crypto).

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.

@seankhliao
Copy link
Member

I don't think this is relevant anymore now that /pkg/ points to pkg.go.dev

@golang golang locked and limited conversation to collaborators Dec 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
FeatureRequest FrozenDueToAge NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Projects
None yet
Development

No branches or pull requests

6 participants