Add pre-commit hooks for checking that docs are building correctly #128
Labels
enhancement
New feature or request
good first issue
Good for newcomers
prio:medium
Clear benefit of this feature. Will be worked on unless there are high or critical priority tasks.
Is your feature request related to a problem? Please describe.
Vercel queues the docusaurus builds but can be a bit slow. Usually, docusaurus fails on broken links and then one needs to either inspect the vercel logs or build manually to see which links caused the build to fail.
Describe the solution you'd like
Add a git pre-commit hook to run
yarn build
in thedocs
folder but only if there are changes in the documentation. We could usehusky
for this.Describe alternatives you've considered
An alternative is to not fail builds on broken links but that is not desirable since broken links should not be part of the documentation.
The text was updated successfully, but these errors were encountered: