configure acronyms

Author: devalog

.vale.ini

@@ -4,9 +4,13 @@ MinAlertLevel = suggestion
 
 Packages = Microsoft
 
+[formats]
+mdx = md
+
 [*.mdx]
 BasedOnStyles = Microsoft, FernStyles
 
 # Disable specific rules
 Microsoft.GenderBias = NO # Not relevant for technical documentation
+Microsoft.Acronyms = NO # Handled in FernStyles
 

.vale/styles/FernStyles/Acronyms.yml

@@ -0,0 +1,65 @@
+extends: conditional
+message: "'%s' has no definition."
+link: https://docs.microsoft.com/en-us/style-guide/acronyms
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - API
+  - ASP
+  - CLI
+  - CPU
+  - CSS
+  - CSV
+  - DEBUG
+  - DOM
+  - DPI
+  - FAQ
+  - GCC
+  - GDB
+  - GET
+  - GPU
+  - GTK
+  - GUI
+  - HTML
+  - HTTP
+  - HTTPS
+  - IDE
+  - JAR
+  - JSON
+  - JSX
+  - LESS
+  - LLDB
+  - NET
+  - NOTE
+  - NVDA
+  - OSS
+  - PATH
+  - PDF
+  - PHP
+  - POST
+  - RAM
+  - REPL
+  - RSA
+  - SCM
+  - SCSS
+  - SDK
+  - SQL
+  - SSH
+  - SSL
+  - SVG
+  - TBD
+  - TCP
+  - TODO
+  - URI
+  - URL
+  - USB
+  - UTF
+  - XML
+  - XSS
+  - YAML
+  - ZIP
+  - MDX # Fern-specific

.vale/styles/FernStyles/Please.yml

@@ -3,4 +3,4 @@ message: "Avoid using '%s' in technical documentation."
 level: warning
 ignorecase: true
 tokens:
-  - please
+  - please # Instead of "Please refer to the documentation", say "Refer to the documentation"

fern/products/docs/pages/getting-started/quickstart.mdx

@@ -180,14 +180,11 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
 
   <AccordionGroup toc={true}>
     <Accordion title='Publishing your docs'>
-      When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI.
-
-      [Read more.](/learn/docs/preview-publish/publishing-your-docs)
+      When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI. [Read more.](/learn/docs/preview-publish/publishing-your-docs)
     </Accordion>
     <Accordion title='Host on a custom domain'>
       Fern supports hosting your docs website on a custom domain or on a 
       custom subpath (e.g. `https://example.com/docs`).
-
       Please reach out to the Fern team at [email protected] to configure this.
     </Accordion>
     <Accordion title='Configure analytics'>