Add Vale vocabulary list (#1674)

This PR:

- Adds a custom word list of accepted terms
- Removes some rejected terms from the Google word list
- Addresses all errors related to the word lists

We *should* be able to safely turn Vale CI checks back on in the
Mintlify dashboard after this PR is merged. There might be some
unnecessary noise from warnings and suggestions at first but we can
continue to iterate on them to make them useful.

Author: sg-writer

.vale.ini

@@ -1,5 +1,6 @@
 StylesPath = .vale/styles
 MinAlertLevel = suggestion
+Vocab = ngrok
 Packages = Google, MDX
 [*.mdx]
-BasedOnStyles = Google
+BasedOnStyles = Google

.vale/styles/Google/Headings.yml

@@ -1,7 +1,7 @@
 extends: capitalization
 message: "'%s' should use sentence-style capitalization."
 link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
-level: warning
+level: error
 scope: heading
 match: $sentence
 indicators:

.vale/styles/Google/WordList.yml

@@ -1,20 +1,19 @@
 extends: substitution
 message: "Use '%s' instead of '%s'."
 link: "https://developers.google.com/style/word-list"
-level: warning
+level: error
 ignorecase: false
 action:
   name: replace
 swap:
   "(?:API Console|dev|developer) key": API key
   "(?:cell ?phone|smart ?phone)": phone|mobile phone
-  "(?:e-mail|Email|E-mail)": email
+  "(?:e-mail|E-mail)": email
   "(?:ok|Okay)": OK|okay
   "(?:WiFi|wifi)": Wi-Fi
   '[\.]+apk': APK
   '3\-D': 3D
   "tap (?:&|and) hold": touch and hold
-  "un(?:check|select)": clear
   action bar: app bar
   Ajax: AJAX
   a\.k\.a|aka: or|also known as
@@ -30,18 +29,15 @@ swap:
   in order to: to
   long press: touch and hold
   network IP address: internal IP address
-  Ngrok: ngrok
   omnibox: address bar
-  regex: regular expression
   SHA1: SHA-1|HAS-SHA1
   sign into: sign in to
-  sign-?on: single sign-on
   static IP address: static external IP address
   stylesheet: style sheet
   synch: sync
   tablename: table name
   tablet: device
   touch: tap
-  url: URL
+
   vs\.: versus
   World Wide Web: web

.vale/styles/config/vocabularies/ngrok/accept.txt

@@ -0,0 +1,116 @@
+(API|api)(s)?
+(SDK|sdk)(s)?
+[Dd]ogfood(ing)?
+[Dd]oglab(bing)?
+[Hh]omefooding
+[Hh]omelab(s)?
+[Hh]ostname(s)?
+[Ii]ngress(ed|ing)?
+[Oo]llama
+[Pp]roxying
+[Rr]insed
+[Ss]imple[Ll]ogin
+[Ss]mithery
+[Vv]ijil
+agentic
+anonymized
+authtoken
+automations
+Bazel
+Buildkite
+CloudFront
+config
+configs
+coreruleset
+CR[Ss]
+CRD(s)?
+datacenter(s)?
+Datadog
+DeepSeek
+dev
+devs
+Docusaurus
+doxx(ing)?
+exfiltrate
+footguns
+freshrss
+[Gg]eo
+gists
+GPU(s)?
+Groq
+HAProxy
+hardcoded
+immich
+internet's
+(IP|ip)(s)?
+LLM(s)?
+Lua
+masse
+MCP(s)?
+middleware
+monorepo
+multicloud
+multicluster
+MySQL
+nd
+(nginx|NGINX)
+ngrok
+ngrokker(s)?
+(OAuth|oauth)
+operationalize
+Postgre(s|SQL)
+protonmail
+[Pp]rox(y|ied)
+proxmox
+reframed
+[Rr]epo
+rollout
+shortener
+smidge
+subcommand
+toolset
+Twilio
+umami
+uncopyable
+upstreams
+Vercel
+Vin
+VM(s)?
+(VPN|vpn)(s)?
+WIP(s)?
+Wireguard
+workshopping
+shortener
+[Ss]erverless
+onboarded
+Webflow
+allowlist(s)?
+pluggability
+[Ff]ailover(s)?
+[Dd]ataplane(s)?
+[Cc]ontrolplane(s)?
+[Ss]hinobi
+[Pp]entest(s)?
+[Cc]leartext
+RPC(s)?
+GPTBot
+papercut(s)?
+[Cc]omposable
+architected
+[Rr]untime(s)?
+unregister
+WAF(s)?
+Uppal
+[Pp]laintext
+ASN(s)?
+blocklist
+namespace
+GitHhub
+livestream
+[Kk]ubernetes
+kube
+kubectl
+CIDR(s)?
+discoverability
+minikube
+healthmed

.vale/styles/config/vocabularies/ngrok/reject.txt

@@ -59,7 +59,7 @@ ngrok http 80 --url https://api.example.com --pooling-enabled
 ngrok http 80 --url https://svc.internal
 ngrok tcp 5432 --url tcp://postgres.internal:5432
 
-# make your endpoint url addressable only from k8s clusters
+# make your endpoint URL addressable only from k8s clusters
 # where you've installed the ngrok k8s operator
 ngrok http 80 --url https://example.namespace --binding kubernetes
 

agent/cli.mdx

@@ -684,7 +684,7 @@ Below are a collection of different agent configurations to serve as examples fo
 
 Here is a basic example configuration file, in this example we are authenticating
 using our authtoken and defining a single HTTPS endpoint named `basic` with a
-endpoint url `basic.ngrok.app` and an upstream url of `localhost:8080`.
+endpoint URL `basic.ngrok.app` and an upstream URL of `localhost:8080`.
 
 ```yaml
 # Version of the ngrok Agent Configuration file. Required.
@@ -802,7 +802,7 @@ agent:
 
 # Endpoint Definitions
 endpoints:
-  # Endpoint with no endpoint url defined to get a randomly assigned ngrok address.
+  # Endpoint with no endpoint URL defined to get a randomly assigned ngrok address.
   - name: my_endpoint_name
     #url: http://  # uncomment this line if you want your endpoint to be HTTP, by default it's HTTPS
     upstream:

agent/config/v3.mdx

@@ -30,7 +30,7 @@ Internet Connectivity
   TLS                                       [ OK ]
 Localhost Connectivity
   Name Resolution                           [ OK ]
-Ngrok Connectivity - Region: Auto (lowest latency)
+ngrok Connectivity - Region: Auto (lowest latency)
   Name Resolution                           [ OK ]
   TCP                                       [ OK ]
   TLS                                       [ OK ]

agent/diagnose.mdx

@@ -347,7 +347,7 @@ tolerance window, it terminates the connection and begins reconnecting.
 
 ngrok's heartbeat mechanism allows it to recover from any type of network
 outage, even those caused by packet loss, dynamic IP changes, interface changes
-(for example, WiFi to LTE) or complete network outages.
+(for example, Wi-Fi to LTE) or complete network outages.
 
 The ngrok service also sends its own heartbeats to the agent which it uses to detect
 liveness and terminate dead connections.

agent/index.mdx

@@ -400,7 +400,7 @@ Returns a 200 response on success
 | `edge`              | [Ref](#ref-fields) | the edge serving requests to this endpoint, if this is an edge endpoint                                                                                   |
 | `upstream_url`      | string             | the local address the tunnel forwards to                                                                                                                  |
 | `upstream_protocol` | string             | the protocol the agent uses to forward with                                                                                                               |
-| `url`               | string             | the url of the endpoint                                                                                                                                   |
+| `url`               | string             | the URL of the endpoint                                                                                                                                   |
 | `principal`         | [Ref](#ref-fields) | The ID of the owner (bot or user) that owns this endpoint                                                                                                 |
 | `traffic_policy`    | string             | The traffic policy attached to this endpoint                                                                                                              |
 | `bindings`          | List<string> | the bindings associated with this endpoint                                                                                                                |