Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Closed
sbinet opened this issue Apr 18, 2020 · 4 comments
Closed

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

sbinet opened this issue Apr 18, 2020 · 4 comments
Labels
FeatureRequest Issues asking for a new feature that does not need a proposal. FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite UX Issues that involve UXD/UXR input
Milestone
pkgsite/design-2020

Comments

@sbinet
Copy link
Member

sbinet commented Apr 18, 2020

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)
@gopherbot gopherbot added this to the Unreleased milestone Apr 18, 2020
@julieqiu
Copy link
Member

Thanks for the feedback! We are planning to add this feature in an upcoming round of design changes.

@julieqiu julieqiu added FeatureRequest Issues asking for a new feature that does not need a proposal. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. UX Issues that involve UXD/UXR input labels Apr 20, 2020
@julieqiu julieqiu mentioned this issue May 14, 2020
Closed
@julieqiu julieqiu changed the title go.dev: show README.md of "subpackages" in overview tab x/pkgsite: show README.md of "subpackages" in overview tab Jun 15, 2020
@julieqiu julieqiu removed the website label Sep 22, 2020
@julieqiu julieqiu removed the website label Sep 22, 2020
This was referenced Sep 23, 2020
Closed
Closed
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/258314 mentions this issue: internal/postgres: support README in subdirectories

gopherbot pushed a commit to golang/pkgsite that referenced this issue Sep 30, 2020
@julieqiu
internal/postgres: support README in subdirectories
6cce679 
When the unit-page experiment is on, GetUnit will return the README for
that path, instead of the one that the module root.

For golang/go#38513
For golang/go#39629

Change-Id: I7a7bcb5762c614e5abb828b3d530207d24562339
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/258314
Run-TryBot: Julie Qiu <[email protected]>
Reviewed-by: Jonathan Amsterdam <[email protected]>
Trust: Julie Qiu <[email protected]>
@julieqiu
Copy link
Member

This feature is now available on beta.pkg.go.dev. See #41585 (comment) for details.

Closing this issue for #41586.

@sbinet
Copy link
Member Author

sbinet commented Oct 29, 2020

thanks! looking great.

@golang golang locked and limited conversation to collaborators Oct 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FeatureRequest Issues asking for a new feature that does not need a proposal. FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite UX Issues that involve UXD/UXR input
Projects
None yet
Milestone
pkgsite/design-2020
Development

No branches or pull requests
3 participants
@sbinet @julieqiu @gopherbot