Skip to content

Conversation

@hahnbeelee
Copy link
Member

@hahnbeelee hahnbeelee commented Jan 16, 2026

Added documentation for the new mint validate command in 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.

Changes

  • Updated installation.mdx to add a new "Validate documentation build" section under "Additional commands"
  • Documented available flags: --groups and --disable-openapi
  • Added GitHub Actions workflow examples showing how to use the command in CI/CD pipelines

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


Note

Introduces mint validate for strict documentation builds, intended for CI usage.

  • Adds Validate documentation build section in installation.mdx with mint validate usage
  • Documents flags: --groups [groupname] and --disable-openapi
  • Provides GitHub Actions examples using npx mint validate, including group-specific validation

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

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
```

The command runs a full documentation build and exits with a non-zero status code if validation fails, making it ideal for automated workflows.

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 <...> for placeholders tends to read clearer than [...] here.

Suggested change
- `--groups <groupname>`: Mock user groups for validation (useful when testing partial authentication).


Add the validate command to your CI pipeline to catch documentation issues before deployment:

```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

In CI, npx can sometimes prompt to install the package; adding --yes prevents hangs.

Suggested change
```yaml
run: npx --yes mint validate

run: npx mint validate
```
```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here to keep the workflow non-interactive.

Suggested change
```yaml
run: npx --yes mint validate --groups admin

@ethanpalm
Copy link
Collaborator

closing in favor of #2736

@ethanpalm ethanpalm closed this Jan 16, 2026
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