Open SilasBerger opened 8 months ago
is the purpose to find broken links? maybe you could use the docusaurus infra for this:
is the purpose to find broken links? maybe you could use the docusaurus infra for this:
- config: https://docusaurus.io/docs/docusaurus-core#useBrokenLinks
- hook for custom components: https://docusaurus.io/docs/docusaurus-core#useBrokenLinks
- anchor checks are supported too: https://docusaurus.io/blog/releases/3.1#broken-anchors-checker
It's mainly about a "can we still successfully open a docs page" sort of sanity check. I'm also thinking about extending this idea to a more thorough check on the component gallery to see if no generated components (e.g. from directives) went bust.
I'm afraid i still not getting it 100% 😅 Is the focus to check internal doc links or external ones aswell? Doesn't docusaurus fails to build, when internal links are not routeable? (At least when their Link Component is used, it shall be checked...)
Consider adding some basic smoke test-style e2e tests for each site, which:
Add checks to pipeline (possibly only for
main
).