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.

Sign up for GitHub

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

Jump to bottom

x/pkgsite: short summary of package on search page unreadable #44174

Closed
katiehockman opened this issue Feb 8, 2021 · 2 comments
Closed

x/pkgsite: short summary of package on search page unreadable #44174

katiehockman opened this issue Feb 8, 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/frontend Issues related to pkgsite HTML/CSS/JavaScript and frontend development pkgsite
Milestone
pkgsite/frontend

Comments

@katiehockman
Copy link
Contributor

For certain packages, the high-level summary of the package is unreadable in the search page. For example, searching for "fmt" comes up with the standard library package (which is easy to read) and another package "github.com/astaxie/beego/orm":

fmt_page

It's actually not totally clear to me what is being printed in the search page, since the README of that package appears to be different for me when I actually click into it. It also has an image that doesn't render.

I don't actually know if there is anything you can/want to do about this, since it's likely working as intended. But I wanted to bring it up as a UX issue.

@julieqiu
@katiehockman katiehockman added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite labels Feb 8, 2021
@gopherbot gopherbot added this to the Unreleased milestone Feb 8, 2021
@julieqiu
Copy link
Member

julieqiu commented Feb 8, 2021

The issue here is that the package synopsis is missing a period at the end of the first sentence:
https://github.com/astaxie/beego/blob/v1.12.3/orm/orm.go#L17

I think it makes sense for us to truncate the package synopsis after a certain length on the search results page. For example:

image

/cc @georgehu

@julieqiu julieqiu modified the milestones: Unreleased, pkgsite/frontend Feb 8, 2021
@gopherbot
Copy link

Change https://golang.org/cl/290549 mentions this issue: internal/frontend: limit synopsis on search page

@golang golang locked and limited conversation to collaborators Feb 9, 2022
@hyangah hyangah added the pkgsite/frontend Issues related to pkgsite HTML/CSS/JavaScript and frontend development label May 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite/frontend Issues related to pkgsite HTML/CSS/JavaScript and frontend development pkgsite
Projects
None yet
Milestone
pkgsite/frontend
Development

No branches or pull requests
4 participants
@hyangah @julieqiu @gopherbot @katiehockman