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: The new index is hard to read #41287

Closed
brackendawson opened this issue Sep 9, 2020 · 3 comments
Closed

x/pkgsite: The new index is hard to read #41287

brackendawson opened this issue Sep 9, 2020 · 3 comments
Labels
Milestone

Comments

@brackendawson
Copy link

@brackendawson brackendawson commented Sep 9, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/net/http?tab=doc

What is your user agent?

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

Screenshot

image

What did you do?

I was looking for the name of a function that does what I want to do.

What did you expect to see?

Expected to quickly find the function I want.

What did you see instead?

Because the index is in a narrow strip on the left, and because functions' returns are no longer in the index; it's very hard to see an overview of the package, because:

  • You can't see the returns of a function in the index. Often seeing a compact list of functions in the package or methods in a type with their arguments and returns is all you need to lead you in the direction of the function that does what you want.
  • In the main view there is little visual cue where one type's methods stop and another type begins. In the index this is very clear due to the indent. Scanning the main page to see functions' returns is visual overload to me, I just want to do it in the index.

In summary, please put the index back near the top like it is on godoc.org.

@gopherbot gopherbot added this to the Unreleased milestone Sep 9, 2020
@brackendawson
Copy link
Author

@brackendawson brackendawson commented Sep 9, 2020

This is the index I'm talking about. Usually just looking at this format of index is almost all I need to use a godoc. It's just a matter of seeing a function that takes what you have and returns what you want then clicking on it to check its docstring:
image

@myitcv
Copy link
Member

@myitcv myitcv commented Sep 9, 2020

Related to (if not a dup of) #40612.

@brackendawson
Copy link
Author

@brackendawson brackendawson commented Sep 9, 2020

Related to (if not a dup of) #40612.

I think my concern is entirely a subset of that issue, thanks.

@jamalc jamalc added the pkgsite label Sep 9, 2020
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
4 participants