mintlify__docs/.claude/commands/lint-docs.md

allowed-tools, description

allowed-tools	description
Bash(mint *), Bash(vale *)	Check documentation for broken links, Vale style errors, and OpenAPI spec validity. Fix linting issues found. Use when the user asks to lint, check for broken links, run Vale, or fix documentation errors.

Run mint broken-links and check the given git diff. For OpenAPI reference updates run mint openai-check.

If the Vale CLI exists, run a Vale check on all changed files.

Make a plan to resolve any broken links or Vale errors.

For more details on the mint CLI, look at the details here:

mint <command>

Commands:
  mint dev                       initialize a local preview environment
  mint openapi-check <filename>  check if an OpenAPI spec is valid
  mint broken-links              check for invalid internal links
  mint rename <from> <to>        rename a file and update all internal link refe
                                 rences
  mint update                    update the CLI to the latest version
  mint upgrade                   upgrade mint.json file to docs.json (current fo
                                 rmat)
  mint migrate-mdx               migrate MDX OpenAPI endpoint pages to x-mint ex
                                 tensions and docs.json
  mint ai [prompt]               Use ai to document a page
  mint version                   display the current version of the CLI and clie
                                 nt                                 [aliases: v]

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

For more information on the Vale CLI, look at the details here:

vale - A command-line linter for prose.

Usage:	vale [options] [input...]
	vale myfile.md myfile1.md mydir1
	vale --output=JSON [input...]

Vale is a syntax-aware linter for prose built with speed and extensibility in
mind. It supports Markdown, AsciiDoc, reStructuredText, HTML, and more.

To get started, you'll need a configuration file (.vale.ini):

Example:

	MinAlertLevel = suggestion

	[*]
	BasedOnStyles = Vale

See https://vale.sh for more setup information.

Flags:

 --config         A file path (--config='some/file/path/.vale.ini').    
 --ext            An extension to associate with stdin (--ext=.md).     
 --filter         An expression to filter rules by.                     
 --glob           A glob pattern (--glob='*.{md,txt}.')                 
 -h, --help       Print this help message.                              
 --ignore-syntax  Lint all files line-by-line.                          
 --minAlertLevel  The minimum level to display (--minAlertLevel=error). 
 --no-exit        Don't return a nonzero exit code on errors.           
 --no-global      Don't load the global configuration.                  
 --no-wrap        Don't wrap CLI output.                                
 --output         An output style ("line", "JSON", or a template file). 
 -v, --version    Print the current version.                            

Commands:

 ls-config        Print the current configuration to stdout.             
 ls-dirs          Print the default configuration directories to stdout. 
 ls-metrics       Print the given file's internal metrics to stdout.     
 ls-vars          Print the supported environment variables to stdout.   
 sync             Download and install external configuration sources.