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

docs: fix links on README #4116

Merged
merged 1 commit into from Jul 5, 2022
Merged

docs: fix links on README #4116

merged 1 commit into from Jul 5, 2022

Conversation

gerardmarquinarubio
Copy link
Contributor

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 inside https://github.com/fastify/fastify/blob/main/README.md relative links will correctly scroll you into the header.

@gerardmarquinarubio
Copy link
Contributor Author

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 😅

Copy link
Member

@climba03003 climba03003 left a 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.

@gerardmarquinarubio
Copy link
Contributor Author

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 fastify.io website?

@climba03003
Copy link
Member

So the README.md is used to generate the front-facing fastify.io website?

Yes

@luisorbaiceta
Copy link
Member

luisorbaiceta commented Jul 5, 2022

We are not using the README @climba03003 See here

@climba03003
Copy link
Member

We are not using the README @climba03003

So, it is the only piece that is not using for generating the website?
Then, I am OK to the changes.

@climba03003 climba03003 changed the title Fix links on README docs: fix links on README Jul 5, 2022
@climba03003 climba03003 merged commit 515577a into fastify:main Jul 5, 2022
@github-actions
Copy link

github-actions bot commented Jul 6, 2023

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants