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
docs: fix links on README #4116
Conversation
I just wrote this PR because I have been learning Fastify and found it inconvenient to effectively double click every time I had to check something quickly in the readme. Sorry if I broke any contributing guidelines but it is such a simple fix that I couldn't help myself 😅 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The website of fastify
is generated based on document file.
I think the change of relative link may break the website.
So the README.md is used to generate the front-facing |
Yes |
We are not using the README @climba03003 See here |
So, it is the only piece that is not using for generating the website? |
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
I know this is an stupid PR but clicking any relative link from
https://github.com/fastify/fastify
README.md preview will take you to the desired href but not scroll you into view of the specified header in the link. Once you are already insidehttps://github.com/fastify/fastify/blob/main/README.md
relative links will correctly scroll you into the header.