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

chore: add mdbook to pre-commit hooks if installed #59

Merged
merged 1 commit into from
Jun 17, 2024

Conversation

mlegner
Copy link
Collaborator

@mlegner mlegner commented Jun 17, 2024

This check ensures that the documentation can be built successfully if mdbook is installed. If mdbook-linkcheck is installed as well, it also checks that all links in the docs are valid.

@mlegner mlegner requested a review from asonnino June 17, 2024 07:17
.pre-commit-config.yaml Show resolved Hide resolved
Copy link
Contributor

@giac-mysten giac-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mlegner ! Is this to check that the build works locally? if yes, I think the check never fails

.pre-commit-config.yaml Show resolved Hide resolved
@mlegner mlegner enabled auto-merge (squash) June 17, 2024 08:29
@mlegner mlegner merged commit 8a9c845 into main Jun 17, 2024
5 checks passed
@mlegner mlegner deleted the ml/chore-pre-commit-mdbook branch June 17, 2024 08:35
giac-mysten pushed a commit that referenced this pull request Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants