fix(docs): repair broken links in CONTRIBUTING.md#13647
Conversation
Update relative links to use root-relative paths (/docs/...) so they resolve correctly when viewing the file via the GitHub "Contributing" overlay tab.
alexrashed
left a comment
There was a problem hiding this comment.
Hi @Septic-H!
Could you maybe share concrete links on how to find the currently deployed wrong links?
I tried going to https://github.com/localstack/localstack/contribute and then to "Read the contributing guidelines" and then click through the first few prominent links. They all worked just fine for me?
|
Hey @alexrashed! You can reproduce it instantly with this link: Or, to navigate there manually:
It gives a 404 error because it tries to find the file relative to root, not docs/. |
alexrashed
left a comment
There was a problem hiding this comment.
That is a great catch, thank you very much for the proactive contribution, and for the explanations on how to reproduce it!
I'll directly merge this one. 🚀
Motivation
While setting up my development environment to contribute to LocalStack, I accessed the Contributing guidelines via the repository's main page overlay. I noticed that clicking on key setup links (specifically "Development Environment Setup", "LocalStack Concepts", and"Testing") resulted in 404 Page Not Found errors. Spent a solid 5 mins wondering where the files are supposed to be.
This happens because the overlay renders the Markdown from the repository root, breaking the relative links that assume the user is browsing inside the
docs/directory.Changes
Updated the links in
docs/CONTRIBUTING.mdto use root-relative paths (e.g.,/docs/development-environment-setup/README.md). This ensures the links resolve correctly in both the file browser view and the main "Contributing" overlay tab.Tests
Manually verified that the new paths correctly point to the existing files in the repository structure.
Related
N/A