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

fix: broken links in docs/guide/why.md #17800

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

akshays-repo
Copy link

@akshays-repo akshays-repo commented Jul 31, 2024

Description

This pull request addresses the issue of broken links in the docs/guide/why.md file that were resulting in "file not found" errors when we try to click from the github.

image

- Fixed broken links in why.md that were resulting in "file not found" errors when clicked.
- Ensured all links point to the correct files and are accessible.
- Verified the changes by testing each link for proper redirection.
Copy link

stackblitz bot commented Jul 31, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@akshays-repo akshays-repo changed the title Fix: broken links in docs/guide/why.md fix: broken links in docs/guide/why.md Jul 31, 2024
@patak-dev
Copy link
Member

These links are not meant to be followed in GitHub. They work fine in the deployed docs https://vitejs.dev/guide/why.html

But I think we could change this. I'll ask to others to see what they think. Maybe we could move all internal links to use .md if there is consensus. Right now it is a mixed bag.

@bluwy
Copy link
Member

bluwy commented Aug 1, 2024

Yeah I think it makes sense to enforce .md, but it won't resolve every links. Some links we're using root paths too, like [why](/guide/why), and that won't work when editing on github, e.g.

If you're new to Vite, we suggest reading first the [Getting Started](/guide/) and [Features](/guide/features) guides.

So if we want to really support this, we need every links to be relative and with .md. I'm not sure how feasible is that 🤔 I don't mind making everything relative though, but I'd prefer if there's a script or lint rule that can auto-fix them now and for the future.

Copy link
Member

@patak-dev patak-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I think we could merge this one for now though, since we already have mixed paths in other guides.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants