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

CHANGELOG points to broken links #18800

Closed
1 of 4 tasks
MizouziE opened this issue Nov 27, 2024 · 0 comments · Fixed by #18802
Closed
1 of 4 tasks

CHANGELOG points to broken links #18800

MizouziE opened this issue Nov 27, 2024 · 0 comments · Fixed by #18802
Labels
contribution welcome documentation Improvements or additions to documentation

Comments

@MizouziE
Copy link

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

The changelog uses relative URLs for the links it displays for Docs and Migration Guide which bring users to 404 pages when following them from GitHub pages, for example when reviewing a dependabot PR. Also, having being brought to the GitHub repo to view the documentation, a lot of the links within the pages are relative to suit the https://vite.dev/guide/ site, but on GitHub will also 404.

Seeing as the https://vite.dev/ site's link for the CHANGELOG points back to the GitHub repo, those links displayed could be more reliable.

Your Suggestion for Changes

Pointing users from the changelog to the GitHub repo seems like the wrong thing to do, it would be better to point them to the https://vite.dev/guide/ site, where all the information is the same and the links between pages all work seamlessly.

Reproduction

No response

Steps to reproduce

No response

@MizouziE MizouziE added the documentation Improvements or additions to documentation label Nov 27, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution welcome documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants