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: how to improve the poor usability of the documentation "Index" section #57138

Open
mark-summerfield opened this issue Dec 7, 2022 · 4 comments
Labels
NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. pkgsite

Comments

@mark-summerfield
Copy link

For larger packages the doc generated "Index" section is most unhelpful.
See for example, the Go FLTK bindings.

There are two separate ways this could be improved:

  1. For types with methods, show, e.g., " type BmpImage" with no methods, unless the user clicks the triangle in which case it becomes "▼ type BmpImage" with all the methods shown (as now).

  2. When there are more than some threshold number of functions (or methods) — say 7, where the first word is the same (e.g., func Draw(), func DrawArc(...), ..., func DrawYxLine3(...)), use the same technique as decribed above in 1.

These changes would make navigation much easier.

@seankhliao seankhliao changed the title How to improve the poor usability of the documentation "Index" section x/pkgsite: how to improve the poor usability of the documentation "Index" section Dec 7, 2022
@gopherbot gopherbot added this to the Unreleased milestone Dec 7, 2022
@seankhliao
Copy link
Member

I think that's what the sidebar is for. When I see an index, I expect to see ~everything without having to click each type to know what methods it has.

@mark-summerfield
Copy link
Author

That's fine for when you have less than, say, 50 functions and methods altogether, but is unusable when you have a lot more than that.

@dle8 dle8 added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Dec 8, 2022
@dle8
Copy link

dle8 commented Dec 8, 2022

Thanks for the issue but this is probably not what we want to do now. If there's more demand for this feature, we will reconsider this in the future.

@dle8 dle8 modified the milestones: Unreleased, pkgsite/unplanned Dec 8, 2022
@mark-summerfield
Copy link
Author

mark-summerfield commented Dec 11, 2022

Another example of nearly unusable documentation (because of the Index being far too long) is gotk3's documentation.

A lesser change that would help is to change the Alt+F search dialog (which incidentally, knocks out Alt+F access to the File menu), so that instead of listing everything, it just listed types and sections (e.g., consts, vars), thus making it a bit more useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. pkgsite
Projects
None yet
Development

No branches or pull requests

4 participants