From 33e70867f03ca092d59f17ce87853f9e83d04433 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Fri, 16 Jan 2026 09:51:45 -0800 Subject: [PATCH 1/4] Update installation.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- installation.mdx | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/installation.mdx b/installation.mdx index b3b333e96..dba6046fb 100644 --- a/installation.mdx +++ b/installation.mdx @@ -170,6 +170,38 @@ If this `mint update` command is not available on your local version, re-install ## Additional commands +### Validate documentation build + +Validate your documentation build in strict mode, which exits with an error if any warnings or errors are detected. This command is designed for CI/CD pipelines to prevent broken documentation from being deployed. + +```bash +mint validate +``` + +The command runs a full build validation and exits with a non-zero status code if any issues are found, making it ideal for automated workflows. + +#### Available flags + +- `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication) +- `--disable-openapi`: Disable OpenAPI file generation during validation + +#### Example: Using in CI workflows + +Add the validate command to your CI pipeline to catch documentation issues before deployment: + +```yaml +# GitHub Actions example +- name: Validate documentation + run: npx mint validate +``` + +```yaml +# GitLab CI example +validate-docs: + script: + - npx mint validate +``` + ### Find broken links Identify any broken internal links with the following command: From 373931c449bb745733f1d1239558a933b257b2f2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 16 Jan 2026 15:57:47 -0800 Subject: [PATCH 2/4] copyedit for concision --- installation.mdx | 60 ++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 32 deletions(-) diff --git a/installation.mdx b/installation.mdx index dba6046fb..69824de01 100644 --- a/installation.mdx +++ b/installation.mdx @@ -170,38 +170,6 @@ If this `mint update` command is not available on your local version, re-install ## Additional commands -### Validate documentation build - -Validate your documentation build in strict mode, which exits with an error if any warnings or errors are detected. This command is designed for CI/CD pipelines to prevent broken documentation from being deployed. - -```bash -mint validate -``` - -The command runs a full build validation and exits with a non-zero status code if any issues are found, making it ideal for automated workflows. - -#### Available flags - -- `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication) -- `--disable-openapi`: Disable OpenAPI file generation during validation - -#### Example: Using in CI workflows - -Add the validate command to your CI pipeline to catch documentation issues before deployment: - -```yaml -# GitHub Actions example -- name: Validate documentation - run: npx mint validate -``` - -```yaml -# GitLab CI example -validate-docs: - script: - - npx mint validate -``` - ### Find broken links Identify any broken internal links with the following command: @@ -230,6 +198,34 @@ mint a11y --skip-contrast mint a11y --skip-alt-text ``` +### Validate documentation build + +Validate your documentation build in strict mode, which exits with an error if any warnings or errors are detected. Use this command for CI/CD pipelines to prevent broken documentation from being deployed. + +```bash +mint validate +``` + +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 + + + +```yaml GitHub Actions example +- name: Validate documentation + run: npx mint validate +``` + +```yaml GitLab CI example +validate-docs: + script: + - npx mint validate +``` + + + ### Check OpenAPI spec Check your OpenAPI file for errors with the following command: From 164c87886980112209531bed74f43d7868bd2c86 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 16 Jan 2026 16:00:27 -0800 Subject: [PATCH 3/4] vale --- installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation.mdx b/installation.mdx index 69824de01..0c0fcbb4f 100644 --- a/installation.mdx +++ b/installation.mdx @@ -200,7 +200,7 @@ mint a11y --skip-alt-text ### Validate documentation build -Validate your documentation build in strict mode, which exits with an error if any warnings or errors are detected. Use this command for CI/CD pipelines to prevent broken documentation from being deployed. +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. ```bash mint validate From 3156ac6ea52c24fb5f979d4b3d68ef5c21bee3c0 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 16 Jan 2026 16:02:07 -0800 Subject: [PATCH 4/4] remove brief example --- installation.mdx | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/installation.mdx b/installation.mdx index 0c0fcbb4f..b4e943cae 100644 --- a/installation.mdx +++ b/installation.mdx @@ -211,21 +211,6 @@ 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 - - -```yaml GitHub Actions example -- name: Validate documentation - run: npx mint validate -``` - -```yaml GitLab CI example -validate-docs: - script: - - npx mint validate -``` - - - ### Check OpenAPI spec Check your OpenAPI file for errors with the following command: