documentationenhancementhelp wanted
仓库指标
- 星标
- (392 个星标)
- PR 合并指标
- (平均合并 4天 11小时) (30 天内合并 3 个 PR)
描述
Why the new feature should be added
When the user clicks on a link on the documentation site, they expect it to work and it should not produce a 404.
If a link has changed and the target site redirects to a new page today, we should know about it to update the link, as it might no longer forward the link tomorrow.
How the new feature should work
The documentation site should have all internal links working, external should work as well as well (but might be unavailable at time of build).
There are tools like https://linkchecker.github.io/linkchecker/ that can be part of the build.
There are multiple places where this could be integrated:
- as a GitHub action on the main repo (then it would give immediate feedback on pull requests, but not block the docs build)
- on the builds in the docs repo, maybe even when it runs on Netlify (then it would block publishing of the docs).