.vale.ini

; Vale configuration for Mintlify docs.
; Mintlify CI will pick this up if enabled:
; https://www.mintlify.com/docs/deploy/ci
;
; Keep this file under version control and evolve it with the docs:
; https://www.mintlify.com/guides/maintenance
;
; Vale config reference:
; https://vale.sh/docs
;
; MDX support:
; - Vale 3.13+ treats .mdx as a first class format.
; - MDX parsing is handled by the external mdx2vast CLI, which must be
;   installed and available on $PATH:
;     npm install -g mdx2vast
;
; When Vale flags something that is actually OK:
; - If it is project-wide (for example a product name), add it to:
;     .vale/styles/config/ignore/authdocs.txt
; - If it is a systematic branding issue, add a swap to:
;     .vale/styles/AuthDocs/Brands.yml
; - Only use {/* vale off */} / {/* vale on */} for
;   narrow, one-off cases (quotes, unusual examples).

StylesPath = auth4genai/.vale/styles

; Only report error-level issues. Suggestions and warnings are suppressed
; entirely so devs are not blocked on minor style nits.
MinAlertLevel = error

; Scopes to ignore completely. These are either:
; - Already covered by other tooling, or
; - Places where language checks are too noisy or fragile
;   (inline code, URLs, links, images).
; Note: 'code' is handled by SkippedScopes below for block-level code.
IgnoredScopes = tt, img, url, a

; Skip entire blocks that are not prose. This keeps Vale out of
; style/script tags, <pre> blocks, code fences, and figures.
SkippedScopes = script, style, pre, figure, code

; Optional checks developers may enable locally:
; vale.Annotations = YES

[*.mdx]
; Base on Vale's core rules plus our custom AuthDocs style:
; https://vale.sh/docs/getting-started/configuration/#basedonstyles
BasedOnStyles = Vale, AuthDocs

; Keep helpful core rules for terminology consistency and
; repeated word detection across the docs.
Vale.Terms = YES
Vale.Repetition = YES

; Replace the built-in spelling rule with a custom one that knows about our
; domain-specific vocabulary:
; https://vale.sh/docs/checks/spelling
; Turning Vale.Spelling off here avoids double reporting issues that our
; AuthDocs.Spelling rule already handles with an ignore list.
Vale.Spelling = NO
AuthDocs.Spelling = YES

; Substitution rule for brand capitalization and common typos:
; https://vale.sh/docs/checks/substitution
; Keep this focused so that automated fixes remain predictable.
AuthDocs.Brands = YES

[*.md]
; Apply the same style stack to plain Markdown files so behavior
; is consistent across .md and .mdx content.
BasedOnStyles = Vale, AuthDocs

; Keep behavior consistent with MDX files.
Vale.Terms = YES
Vale.Repetition = YES

; Use the same custom spelling + brand rules as MDX.
Vale.Spelling = NO
AuthDocs.Spelling = YES
AuthDocs.Brands = YES

; Snippets and code-heavy examples: disable brand rules.
; These files are mostly inline code and copied examples where
; strict brand enforcement would generate a lot of noise.
[snippets/**/*.mdx]
AuthDocs.Brands = NO

; Component demo content: disable spelling and brand rules.
; This page is primarily example copy used to exercise UI components,
; not user-facing documentation.
[components.mdx]
AuthDocs.Brands = NO
AuthDocs.Spelling = NO

; Sample app index pages: disable brands.
; Mostly links, titles, and names where strict enforcement over-triggers.
[mcp/sample-apps.mdx]
AuthDocs.Brands = NO

[sample-apps.mdx]
AuthDocs.Brands = NO

; GitHub integration page: disable brands.
; Contains github in URLs and domain-like strings where strict brand
; correction would generate noise.
[integrations/github.mdx]
AuthDocs.Brands = NO

; GitHub how-to snippet files: disable brands.
; Contain lowercase github in text and URLs.
[snippets/how-tos/github/**/*.mdx]
AuthDocs.Brands = NO

; SDK documentation pages: disable brands.
; Contain GitHub sample repository URLs.
[sdks/**/*.mdx]
AuthDocs.Brands = NO

; Overview and hub pages: disable brands.
; Mostly cards and links that aggregate other content.
[how-tos/overview.mdx]
AuthDocs.Brands = NO