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

Links in GitHub docs/ broken? #24151

Open
tzarc opened this issue Jul 18, 2024 · 0 comments
Open

Links in GitHub docs/ broken? #24151

tzarc opened this issue Jul 18, 2024 · 0 comments

Comments

@tzarc
Copy link
Member

tzarc commented Jul 18, 2024

If you've been linked this issue on one of your PRs, thanks for putting in the effort to raise it, but it's incorrect. GitHub isn't the intended viewer for QMK's documentation.

QMK Firmware uses VitePress for publishing docs to the QMK Firmware docs website.
Best practices for VitePress does not include the trailing .md in links, and QMK follows these best practices.

If you wish to view your local copy of the docs -- handy when you're making a PR -- make sure you have yarn installed and run qmk docs.

Issues and PRs asking to "fix", or "fixing" the trailing .md will be closed.

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

No branches or pull requests

1 participant