-
Notifications
You must be signed in to change notification settings - Fork 1k
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][RFC]: Strategy to maintain working links #11886
Comments
Semi-related: I just noticed this output from our docusaurus build on Netlify:
We should probably look into those 🙈 |
The root cause for that obviously was #11874 🙈 – which i believe you already fixed via #11891. Would have been caught if that was be part of the CI (again?). I believe i remember a time when the docs were autodeployed on vercel as a preview (or maybe i'm remembering that for a completely different project). That would also be a good one for this strategy 👍 BTW – do you think you could edit the error log in the above message in an |
Summary and description
Regarding the handling of links there is some room for improvement.
Goals
Motivation
It's frustrating for consumers of the docs to click on links which either lead to 404 or (probably even worse) refer to something different than intended by the author(s). Although those make "good first PRs" and thus a low-barrier into the fabulous world of being a Redwood contributor, peoples valuable attention could probably be more effective in other areas 😉
The number of PRs the current situation causes is countless: #751, #5685, #5774, #5896, #8304 #9266, #10505, #10938 #11581, #11772, #11882, …
Possible solutions
Tackling 404s for (non-github) outgoing links
I.e. for Storybook there are different doc links for v6, v7, etc.
Tackling code links (typically github)
blob/main
and – for instance given current docs are v9 – scan anything that is notblob/9…
The text was updated successfully, but these errors were encountered: