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: pkg.go.dev website width too small and truncated #44172

Open
aletheia7 opened this issue Feb 8, 2021 · 2 comments
Open

x/pkgsite: pkg.go.dev website width too small and truncated #44172

aletheia7 opened this issue Feb 8, 2021 · 2 comments

Comments

@aletheia7
Copy link

@aletheia7 aletheia7 commented Feb 8, 2021

What is the URL of the page with the issue?

(https://pkg.go.dev/github.com/google/gopacket@v1.1.19/layers#pkg-variables)

What is your user agent?

Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36

Screenshot

image

What did you do?

Open Google Chrome to read the gopacket/layers package.

What did you expect to see?

I would like to see all of the text normally wrapped on my big monitor.

I would like a page option that allows rendering the full page without 2" margins. I would like a Desktop Mode that allows the page to flow the entire with of the screen.

I would like horizontal overflow scroll bars to view the page when content is too wide.

What did you see instead?

I have a 1920x1200 screen resolution and I cannot read the package documentation. The CSS column widths are truncated, and there are no overflow scroll bars.

Documentation Column Width Truncated

Look at the Functions "GetLCMLayerType(fingd... and RegisterLCMLayerType(n... . See how they are truncated and have ellipses?

Variables Section Width Truncated

See how "LayerTypeARP = gopacket.RegisterLayerType(10, gopacket.LayerTypeMetad" is truncated?

@gopherbot gopherbot added the pkgsite label Feb 8, 2021
@gopherbot gopherbot added this to the Unreleased milestone Feb 8, 2021
@aletheia7 aletheia7 changed the title x/pkgsite: pkg.go.dev Site with too small x/pkgsite: pkg.go.dev website width too small and truncated Feb 8, 2021
@jamalc jamalc added the UX label Feb 8, 2021
@jamalc jamalc modified the milestones: Unreleased, pkgsite/unplanned Feb 8, 2021
@jamalc
Copy link
Member

@jamalc jamalc commented Feb 8, 2021

Thanks for the suggestions. Adding @georgehu @fflewddur for UX feedback.

@magical
Copy link
Contributor

@magical magical commented Feb 20, 2021

I have a similar complaint but on a smaller monitor.

https://pkg.go.dev/os

Screenshot 2021-02-20 145044
Screenshot 2021-02-20 145252

The screen feels incredibly cramped and painful to read. There are five(!) header bars on the top, and two side bars. The documentation is squeezed into a small area on the bottom of the screen. The info bar on the right is completely pointless for a standard library package, yet it takes up 1/4 of the horizontal space.

Scroll down. Like in aletheria7's screenshot, the constant block is cut off. The useless righthand info box isn't even visible any more, yet it still takes up valuable screen space. And, this is just a personal preference, but I would prefer not to have the nav bar follow me everywhere.

Compare with https://golang.org/pkg/os:

Screenshot 2021-02-20 145058 Screenshot 2021-02-20 145313

Only two header bars. The content starts at about the same place down the page due to the table of contents, but the top half of the screen is mostly empty space instead of information-dense headers.

When you scroll down the header bars and TOC disappear. There are no sidebars, the entire screen is dedicated to displaying the docs. The constant block is not cut off, and even has room to spare.

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
5 participants