Skip to content

x/pkgsite: show README.md of "subpackages" in overview tab #38513

@sbinet

Description

@sbinet

currently, go.dev does a nice job for presenting the README.md page for the "top-level" module (usually corresponding to the root of a repository) when clicking on the "overview" page:

it would be nice if, when going to "subdirectories", the "overview" tab could display the corresponding README.md page, if any.

i.e., it would be nice if the following link ("hplot" subdir of go-hep.org/x/hep module):

would display the README page of:

that would help with creating nice looking documentation+examples for packages that need to show images (which isn't the core thing of godoc per se)

Metadata

Metadata

Assignees

No one assigned

    Labels

    FeatureRequestIssues asking for a new feature that does not need a proposal.FrozenDueToAgeNeedsInvestigationSomeone must examine and confirm this is a valid issue and not a duplicate of an existing one.UXIssues that involve UXD/UXR inputpkgsite

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions