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

Jump to bottom

go.dev: overview tab should show README.md, not README.go #38109

Closed
adamluzsi opened this issue Mar 27, 2020 · 4 comments
Closed

go.dev: overview tab should show README.md, not README.go #38109

adamluzsi opened this issue Mar 27, 2020 · 4 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite UX Issues that involve UXD/UXR input
Milestone
Unreleased

Comments

@adamluzsi
Copy link

adamluzsi commented Mar 27, 2020 •
edited

Overview tab shows the wrong readme file

In my project, I have a README.md and a README.go.
One for the project overview, and one for the package level godoc.
On the overview tab in pkg.go.dev, the README.go is displayed instead of the markdown file as for the other projects.

link to an example.

Does this issue reproduce with the latest release?

yes

What did you do?

I made two file in my project

  • README.md
  • README.go

What did you expect to see?

overview tab present the README.md content like for the other projects.

What did you see instead?

README.go content was displayed without as plain text.

PS

Dear Go Team,

I'm not 100% sure if showing the README.md on the overview tab is an expected behavior actually for pkg.go.dev.

Keep up the good work Go Team!

Kind Regards,
Adam
@gopherbot gopherbot added this to the Unreleased milestone Mar 27, 2020
@julieqiu
Copy link
Member

julieqiu commented Apr 6, 2020

Thanks for the feedback! We'll work on a fix for this specific issue to prefer README.md over README.go.

We are planning to address the overview tab as a whole as part of an upcoming round of UX changes.
/cc @fflewddur

@julieqiu julieqiu added UX Issues that involve UXD/UXR input NeedsFix The path to resolution is known, but the work has not been done. labels Apr 6, 2020
@julieqiu julieqiu changed the title go.dev: README file in overview go.dev: overview tab should show README.md, not README.go Apr 6, 2020
@adamluzsi
Copy link
Author

Dear @juliequi,

Thank you for helping!!! This is not blocking me. I wish good health to everyone!

Cheers
Adam

@julieqiu
Copy link
Member

Fixed.

@adamluzsi
Copy link
Author

Thank you so much for fixing my issue,
I really appreciate it!

@golang golang locked and limited conversation to collaborators Apr 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite UX Issues that involve UXD/UXR input
Projects
None yet
Milestone
Unreleased
Development

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