Skip to content
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

Add pre-commit hooks for checking that docs are building correctly #128

Open
nud3l opened this issue Dec 20, 2023 · 0 comments
Open

Add pre-commit hooks for checking that docs are building correctly #128

nud3l opened this issue Dec 20, 2023 · 0 comments
Assignees
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.

Comments

@nud3l
Copy link
Contributor

nud3l commented Dec 20, 2023

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 the docs folder but only if there are changes in the documentation. We could use husky 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.

@nud3l nud3l added enhancement New feature or request prio:medium Clear benefit of this feature. Will be worked on unless there are high or critical priority tasks. labels Dec 20, 2023
@nud3l nud3l added the good first issue Good for newcomers label May 21, 2024
@derrekcoleman derrekcoleman self-assigned this Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
Status: New 🆕
Development

No branches or pull requests

2 participants