Skip to content

Conversation

@hahnbeelee
Copy link
Member

@hahnbeelee hahnbeelee commented Jan 16, 2026

Added documentation for the new mint validate CLI 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 examples

Generated from feat: add new validate-build cli command @rtbarnes


Note

Introduces documentation for validating builds in strict mode, intended for CI/CD.

  • Adds a new "Validate documentation build" section in installation.mdx describing mint validate
  • Documents flags: --groups [groupname] and --disable-openapi

Written by Cursor Bugbot for commit 3156ac6. This will update automatically on new commits. Configure here.

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
@ethanpalm ethanpalm merged commit f1a1a11 into main Jan 17, 2026
6 checks passed
@ethanpalm ethanpalm deleted the mintlify/docs-mint-validate-command-8070 branch January 17, 2026 00:02

### 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.
Copy link
Contributor

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).

Suggested change
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)
Copy link
Contributor

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).

Suggested change
- `--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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- `--disable-openapi`: Disable OpenAPI file generation during validation
- `--disable-openapi`: Disable OpenAPI file generation during validation.

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