-
Notifications
You must be signed in to change notification settings - Fork 17.7k
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: add regression tests HTML anchors of important docs don't change #61499
Comments
cc @golang/tools-team |
Hashrefs in urls are not visible for servers. So the solution should be to add both IDs ( |
@dolmen Can you help us find where |
I have used the hash ref in GitHub issues, PRs, Slack to tell people about godoc links. |
@dolmen I fully understand how frustrating it is when old links no longer work. But I want to understand is what prevents from starting to use the new The source of this link is in https://github.com/golang/website/blob/5c08bf3ee65177ad7160bd55d4a04bc613d6af9b/_content/doc/comment.md?plain=1#L610 As shown, this is a simplified markdown file, which the server processes and renders to a html file. We cannot remove |
If As the anchor seems to be defined in the document (and not by an algorithm) I expect that future breaking changes will be caught by code review. However a regression test on HTML anchors would be useful. Maybe this already somewhat exists if a test checks that links in the whole Go documentation are correctly resolved down to hashrefs. |
Previously the documentation for
go doc
links was at: https://go.dev/doc/comment#doc-linksNow it is at: https://go.dev/doc/comment#doclinks
The difference is in the hashref.
As now both links are in use (probably mostly by myself as I am a big promoter of godoc links), a redirect would be helpful.
The text was updated successfully, but these errors were encountered: