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

Open
sbinet opened this issue Apr 18, 2020 · 1 comment
Open

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

sbinet opened this issue Apr 18, 2020 · 1 comment

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
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
You can’t perform that action at this time.