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

Add canonical URL links to HTML documentation to prevent search engines serving old versions of docs #3864

Open
lpil opened this issue Nov 20, 2024 · 0 comments · May be fixed by #3872
Open
Labels
good first issue Good for newcomers help wanted Contributions encouraged priority:medium

Comments

@lpil
Copy link
Member

lpil commented Nov 20, 2024

Search engines are surfing links to outdated versions of package documentation. This is a problem as it misleads users, especially for core libraries such as the stdlib.

If the documentation had canonical links in the head element then search engines would hopefully suggest the current version instead.

<link rel="canonical" href="https://hexdocs.pm/package_name/path/to/file.html" />

Add this link to docs when publishing.

@lpil lpil added help wanted Contributions encouraged good first issue Good for newcomers priority:medium labels Nov 20, 2024
@rockerBOO rockerBOO linked a pull request Nov 21, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Contributions encouraged priority:medium
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant