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

Jump to bottom

x/pkgsite: move package files to bottom of doc page #40611

Closed
myitcv opened this issue Aug 6, 2020 · 4 comments
Closed

x/pkgsite: move package files to bottom of doc page #40611

myitcv opened this issue Aug 6, 2020 · 4 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite/dochtml Issues related to package documentation in pkgsite pkgsite
Milestone
pkgsite/dochtml

Comments

@myitcv
Copy link
Member

myitcv commented Aug 6, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/cuelang.org/go/cue?tab=doc

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.59 Safari/537.36

Screenshot

Screen Shot 2020-08-06 at 11 15 58

What did you do?

Visited the page.

What did you expect to see?

As a user of the package, the most important information about this package at the top of the page.

What did you see instead?

A long list of the package files.

As a user of the package, I don't really have any need for this information.

If this is required (see #37863) then it should appear towards the bottom, as the primary user of this page is a user of the package.
@myitcv myitcv added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website labels Aug 6, 2020
@gopherbot gopherbot added this to the Unreleased milestone Aug 6, 2020
@myitcv myitcv added pkgsite and removed website labels Aug 6, 2020
@myitcv myitcv changed the title go.dev: package files should not be listed at the top of the page x/pkgsite: package files should not be listed at the top of the page Aug 6, 2020
@julieqiu
Copy link
Member

We can move the package files to the bottom of the page. They were added to that position to match the structure on godoc.org.

Example for https://godoc.org/cuelang.org/go/cue:

Screen Shot 2020-08-17 at 11 03 49 PM

We'll move the package files section to the bottom of the page. Mock to be implemented:

Screen Shot 2020-08-17 at 11 06 29 PM

@julieqiu julieqiu added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Aug 18, 2020
@julieqiu julieqiu changed the title x/pkgsite: package files should not be listed at the top of the page x/pkgsite: move package files to bottom of doc page Aug 18, 2020
@myitcv
Copy link
Member Author

myitcv commented Aug 18, 2020

Thanks @julieqiu. I think my eye/mind must have simply skipped this before because the amount of space this section currently takes up on godoc.org is markedly less that pkg.go.dev. But moving to the bottom sounds sensible - this is useful information, but only to a small percentage of people (citation required).

@julieqiu julieqiu modified the milestones: Unreleased, pkgsite/dochtml Aug 19, 2020
@tooolbox
Copy link

I agree that, with the page exactly as it is, the file listing should be at the bottom.

However, I would venture to say that this problem is really "created" by a combination of:

  1. The exploded formatting of the file listing. Godoc has them jammed together, which is perhaps ugly but very useable, and takes an appropriate amount of space for its significance. I am sure there is a clever solution which can look nicer without requiring as much whitespace as it does now.
  2. The missing index as per x/pkgsite: LHS navigation panel is "lossy"  #40612 and x/pkgsite: auto-expand left sidebar  #40577

I am fairly certain that solving (reverting, perhaps?) those two points would make this a non-issue.

@gopherbot
Copy link

Change https://golang.org/cl/250544 mentions this issue: internal/fetch/dochtml: move package files to bottom of page

@golang golang locked and limited conversation to collaborators Aug 26, 2021
@hyangah hyangah added the pkgsite/dochtml Issues related to package documentation in pkgsite 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 NeedsFix The path to resolution is known, but the work has not been done. pkgsite/dochtml Issues related to package documentation in pkgsite pkgsite
Projects
None yet
Milestone
pkgsite/dochtml
Development

No branches or pull requests
5 participants
@myitcv @tooolbox @hyangah @julieqiu @gopherbot