-
Notifications
You must be signed in to change notification settings - Fork 215
Document mint validate CLI command #2736
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
Conversation
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
|
|
||
| ### Validate documentation build | ||
|
|
||
| Validate your documentation build in strict mode, which exits with an error if there are any warnings or errors. Use this command for CI/CD pipelines to prevent broken documentation deployments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider calling out the non-zero exit code explicitly (makes the CI behavior clearer).
| Validate your documentation build in strict mode, which exits with an error if there are any warnings or errors. Use this command for CI/CD pipelines to prevent broken documentation deployments. | |
| Validate your documentation build in strict mode. The command exits with a non-zero status code if it finds any warnings or errors, which makes it useful in CI/CD pipelines to prevent broken documentation deployments. |
|
|
||
| Use flags to configure the validation command. | ||
|
|
||
| - `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nit: using <groupname> matches the placeholder style used elsewhere on this page (and adding a period keeps the list consistent).
| - `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication) | |
| - `--groups <groupname>`: Simulate user groups during validation (useful when testing partial authentication). |
| Use flags to configure the validation command. | ||
|
|
||
| - `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication) | ||
| - `--disable-openapi`: Disable OpenAPI file generation during validation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - `--disable-openapi`: Disable OpenAPI file generation during validation | |
| - `--disable-openapi`: Disable OpenAPI file generation during validation. |
Added documentation for the new
mint validateCLI command to the installation guide. This command validates documentation builds in strict mode and is designed for CI/CD pipelines to prevent broken documentation from being deployed.Files changed
installation.mdx- Added new "Validate documentation build" section with command usage, available flags, and CI/CD integration examplesGenerated from feat: add new validate-build cli command @rtbarnes
Note
Introduces documentation for validating builds in strict mode, intended for CI/CD.
installation.mdxdescribingmint validate--groups [groupname]and--disable-openapiWritten by Cursor Bugbot for commit 3156ac6. This will update automatically on new commits. Configure here.