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: improve package notes headers #52417

Open
rekby opened this issue Apr 18, 2022 · 2 comments
Open

x/pkgsite: improve package notes headers #52417

rekby opened this issue Apr 18, 2022 · 2 comments
Labels
NeedsInvestigation pkgsite UX

Comments

@rekby
Copy link

@rekby rekby commented Apr 18, 2022

What is the URL of the page with the issue?

https://pkg.go.dev/sync/atomic

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.4 Safari/605.1.15

Screenshot

image

What did you do?

Open document page

What did you expect to see?

I expected to see separator and headers similar to "Package notes".
image

What did you see instead?

Now I see header "Notes" and my first thing about notes related to function "func (*Value) Swap" (not all package) and the Swap function has bug.

@rekby rekby added the pkgsite label Apr 18, 2022
@gopherbot gopherbot added this to the pkgsite/unplanned milestone Apr 18, 2022
@mengzhuo mengzhuo changed the title x/pkgsite: improove package notes headers x/pkgsite: improve package notes headers Apr 22, 2022
@jamalc jamalc added UX NeedsInvestigation labels Apr 22, 2022
@jamalc
Copy link

@jamalc jamalc commented Apr 22, 2022

/cc @jinhongy

@jinhongy
Copy link

@jinhongy jinhongy commented Apr 25, 2022

Here are a few comments from design perspective:

  1. There should be a bug on clicking 'Notes" seems it expanded the functions when I click it.
  2. Thats a great idea to have "Notes" as a separate section. Before doing this change, there is one thing we should take into consideration: Is "Package Notes" a session most other docs would have or for this package only? We have the separator under session title like " Source files" in the captured screen. If most other package docs have the same session, then we can add a new session for "Notes" . If "Note" is for this package only, then I would recommend not adding new pattens here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsInvestigation pkgsite UX
Projects
None yet
Development

No branches or pull requests

4 participants