Skip to content

x/pkgsite: how to improve the poor usability of the documentation "Index" section #57138

@mark-summerfield

Description

@mark-summerfield

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    NeedsDecisionFeedback is required from experts, contributors, and/or the community before a change can be made.pkgsite

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions