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/website: delete obsolete lib/godoc/analysis/help page #66659

Open
xieyuschen opened this issue Apr 3, 2024 · 4 comments
Open

x/website: delete obsolete lib/godoc/analysis/help page #66659

xieyuschen opened this issue Apr 3, 2024 · 4 comments
Labels
help wanted NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website

Comments

@xieyuschen
Copy link
Contributor

What is the URL of the page with the issue?

https://go.dev/lib/godoc/analysis/help

What is your user agent?

Safiri and Chrome

Screenshot

image

What did you do?

normal open the site and view it directly

What did you see happen?

markdown files unreadable with dark theme

What did you expect to see?

i want to see the normal rendered page under dark theme

this issue is the same issue as #64929

@hyangah
Copy link
Contributor

hyangah commented Apr 4, 2024

The source of this page https://github.com/golang/website/blob/master/_content/lib/godoc/analysis/help.html is html (not markdown), and the images are png files. This page doesn't render well anyway. Can we remove the style in the html and also convert to markdown?

@hyangah hyangah added NeedsFix The path to resolution is known, but the work has not been done. help wanted NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. and removed pkgsite NeedsFix The path to resolution is known, but the work has not been done. labels Apr 4, 2024
@hyangah hyangah modified the milestones: Unreleased, website/unplanned Apr 4, 2024
@hyangah hyangah changed the title x/website: markdown files unreadable with dark theme x/website: lib/godoc/analysis/help page unreadable with dark theme Apr 4, 2024
@xieyuschen
Copy link
Contributor Author

The source of this page https://github.com/golang/website/blob/master/_content/lib/godoc/analysis/help.html is html (not markdown), and the images are png files. This page doesn't render well anyway. Can we remove the style in the html and also convert to markdown?

The html doesn't matter if the template is added, as i verified it in my local. I use website@b5fc39c6 to try.

image

@xieyuschen
Copy link
Contributor Author

xieyuschen commented Sep 10, 2024

Hi @hyangah , could I know your opinion here? As changing the template could solve the render issue, changing it to markdown seems un-necessary. If you do think it's better to make all documentation files in markdown extension, I could spend some efforts to change it from html to md.

@adonovan
Copy link
Member

More to the point, this documentation describes features of godoc that no longer exist. We should delete it (and then delete godoc).

@adonovan adonovan changed the title x/website: lib/godoc/analysis/help page unreadable with dark theme x/website: delete obsolete lib/godoc/analysis/help page Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website
Projects
None yet
Development

No branches or pull requests

4 participants