x/pkgsite: show README.md of "subpackages" in overview tab #38513
Milestone
Comments
Thanks for the feedback! We are planning to add this feature in an upcoming round of design changes. |
This was referenced Sep 23, 2020
Change https://golang.org/cl/258314 mentions this issue: |
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>
This feature is now available on beta.pkg.go.dev. See #41585 (comment) for details. Closing this issue for #41586. |
thanks! looking great. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 ofgo-hep.org/x/hep
module):would display the README page of:
(with all the nice images)
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)
The text was updated successfully, but these errors were encountered: