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: show README.md of "subpackages" in overview tab #38513

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

Comments

@sbinet
Copy link
Member

@sbinet 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
@gopherbot gopherbot added the pkgsite label Apr 18, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Apr 20, 2020

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

@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
@gopherbot gopherbot added the go.dev label Sep 18, 2020
@julieqiu julieqiu removed the go.dev label Sep 22, 2020
@gopherbot gopherbot added the go.dev label Sep 22, 2020
@julieqiu julieqiu removed the go.dev label Sep 22, 2020
@gopherbot
Copy link

@gopherbot gopherbot commented Sep 30, 2020

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
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 <julie@golang.org>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
Trust: Julie Qiu <julie@golang.org>
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Oct 29, 2020

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

Closing this issue for #41586.

@julieqiu julieqiu closed this Oct 29, 2020
@sbinet
Copy link
Member Author

@sbinet sbinet commented Oct 29, 2020

thanks! looking great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants