docs: Fix a silent failure in the Vale rules, check CI can catch it (#1464)

.github/workflows/docs-tests.yaml

@@ -24,6 +24,7 @@ jobs:
         with:
           files: '["README.md", "docs"]'
           filter_mode: file
+          fail_on_error: true
 
   linkcheck:
     runs-on: ubuntu-latest

.vale.ini

@@ -2,13 +2,13 @@
 # See: https://docs.errata.ai/vale/config
 
 # The relative path to the folder containing linting rules (styles).
-StylesPath = .github/styles
+StylesPath = ".github/styles"
 
 # Vocab define the exceptions to use in *all* `BasedOnStyles`.
 # spelling-exceptions.txt triggers `Vale.Terms`
 # reject.txt triggers `Vale.Avoid`
 # See: https://docs.errata.ai/vale/vocab
-Vocab = Rules
+Vocab = Redocly-Docs
 
 # Minimum alert level
 # -------------------
@@ -19,10 +19,10 @@ MinAlertLevel = suggestion
 # IgnoredScopes specifies inline-level HTML tags to ignore.
 # These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still won't raise any alerts.
 # Default: ignore `code` and `tt`.
-IgnoredScopes = code, tt, img, url, a, body.id
+IgnoredScopes = code, tt, img, url
+
 # SkippedScopes specifies block-level HTML tags to ignore. Ignore any content in these scopes.
 # Default: ignore `script`, `style`, `pre`, and `figure`.
-# For AsciiDoc: by default, listingblock, and literalblock.
 SkippedScopes = script, style, pre, figure, code, tt, listingblock, literalblock
 
 # Rules for matching file types. See: https://docs.errata.ai/vale/scoping
@@ -34,13 +34,9 @@ mdx = md
 # Rules for .MD, .MDX
 [*.{md,mdx}]
 
-BasedOnStyles = Rules
-# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
-TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
-Vale.Repetition = NO
-Vale.SentenceSpacing = NO
-Vale.Spelling = NO
-
+BasedOnStyles = Redocly-Docs
+# Ignore code surrounded by backticks
+TokenIgnores = (\x60[^\n\x60]+\x60)
 # /End of rules for .MD, .MDX
 
 

docs/commands/lint.md

@@ -109,7 +109,7 @@ Some formats, such as CheckStyle or JSON, don't work well when mulitple APIs are
 
 #### Codeframe (default)
 
-The command `redocly lint --format=codeframe` lints the file and uses the default format of `codeframe`. You will see the same output as below if you omit the `--format` parameter.
+The command `redocly lint --format=codeframe` lints the file and uses the default format of `codeframe`. It produces the same output as below if you omit the `--format` parameter.
 
 ```bash
 [1] museum-with-errors.yaml:19:7 at #/paths/~1museum-hours/get/operationIds