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: long names have poor formatting #44365

Closed
symbiont-ji opened this issue Feb 18, 2021 · 2 comments
Closed

x/pkgsite: long names have poor formatting #44365

symbiont-ji opened this issue Feb 18, 2021 · 2 comments
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite UX Issues that involve UXD/UXR input

Comments

@symbiont-ji
Copy link

symbiont-ji commented Feb 18, 2021

What is the URL of the page with the issue?

https://pkg.go.dev/google.golang.org/api@v0.40.0/compute/v1#pkg-types

What is your user agent?

Version 88.0.4324.182 (Official Build) (64-bit)

Screenshot

image

What did you do?

Just browsing that page

What did you expect to see?

Two things:

  1. I expected the menu on the left that lists all the types and functions to be resizable, so that long names can actually be displayed. As it stands, this is completely useless; to browse them, I have to hover over each one of them and wait for actual url to show at the bottom of the window.
  2. I have a wide screen for a reason. Why are you filling the browser window with empty white space, when you could simply have expanded the individual frames to fill the whole width?

What did you see instead?

This design that makes no sense in the year 2021.

@seankhliao seankhliao changed the title https://pkg.go.dev/google.golang.org/api@v0.40.0/compute/v1 has poor formatting x/pkgsite: long names have poor formatting Feb 18, 2021
@gopherbot gopherbot added this to the Unreleased milestone Feb 18, 2021
@seankhliao seankhliao added the UX Issues that involve UXD/UXR input label Feb 18, 2021
@jba jba added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Feb 18, 2021
@jba jba modified the milestones: Unreleased, pkgsite/unplanned Feb 18, 2021
@julieqiu julieqiu assigned georgehu and unassigned jamalc Feb 18, 2021
@gopherbot
Copy link

Change https://golang.org/cl/313051 mentions this issue: content/static: add titles to type names in doc outline

gopherbot pushed a commit to golang/pkgsite that referenced this issue Apr 23, 2021
Functions already have titles that appear on hover.
This change adds missing titles to typenames. Users
can hover over truncated typenames to see the full
name inline with the links in the outline.

For golang/go#44365

Change-Id: Id86a8eb4e2d0f0269a91f108ae257e920048aa79
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/313051
Trust: Jamal Carvalho <jamal@golang.org>
Run-TryBot: Jamal Carvalho <jamal@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
TryBot-Result: kokoro <noreply+kokoro@google.com>
@golang golang deleted a comment from gopherbot Apr 23, 2021
@jamalc jamalc assigned jamalc and unassigned georgehu May 11, 2021
@jamalc
Copy link

jamalc commented Jul 14, 2021

The layout of the documentation page has been adjusted to make better use of space on larger screens.

@jamalc jamalc closed this as completed Jul 14, 2021
@rsc rsc unassigned jamalc Jun 23, 2022
@golang golang locked and limited conversation to collaborators Jun 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite UX Issues that involve UXD/UXR input
Projects
None yet
Development

No branches or pull requests

6 participants