Merge pull request #49 from couchbaselabs/sarah-fixes-jan-2026

[DOC-13951] Make the Style Guide and Vale Agree

Author: sarahlwelton

ValeStyles/Couchbase/Terminology.yml

@@ -43,6 +43,7 @@ swap:
   file name: filename
   file system: filesystem
   '(?:fine grained|finegrained)': fine-grained
+  Forest DB: ForestDB
   '(?:freeform|free form)': free-form
   '(?:fulltext|full text)': full-text
   '(?:geodistributed|geo distributed)': geo-distributed

ValeStyles/Couchbase/UnexplainedAcronym.yml

@@ -16,6 +16,7 @@ exceptions:
   - ASCII
   - ASP
   - ANY
+  - AWS
   - CALL
   - CASE
   - CAST

ValeStyles/config/vocabularies/Couchbase/accept.txt

@@ -10,6 +10,7 @@ API
 APIs
 App Services
 ASCII
+Atlassian
 automatic schema discovery
 auto-sharding
 Availability Zone
@@ -44,10 +45,12 @@ CPU
 CPUs
 curl
 Database Change Protocol
-datacenter
+[Dd]atacenter
 DataOps
+[Dd]atasheet
 DCP
 DDL
+[Dd]ecrypter
 [Dd]eduplicate
 DevOps
 [Dd]igitization
@@ -57,27 +60,31 @@ Dockerfiles
 Dockerfile
 Elasticsearch
 EMEA
+[Ee]ncrypter
 Engagement Database
 Enterprise Analytics
+ePayment
 ETL
 Event-Condition-Action model
 FAQ
 FaaS
 [Ff]ailover
 [Ff]ailovers
-Forestdb
+ForestDB
 FQDN
 Full-Text Search
 FTS
 Geofencing
 GitHub
 Global Secondary Indexes
 Google Cloud Platform
+GUID
 guid
 gzip
 HTML
 HTAP
 HOAP
+[Hh]ostname
 Hyperscale
 IaaS
 IndexScan
@@ -99,14 +106,19 @@ KV Service
 Last Write Wins
 LWW
 LCB
+libcouchbase
 LDAP
+[Ll]ivestream
 LLM
 MapReduce
 massively parallel processing
 MPP
 Memcached bucket
 Memcached
+[Nn]ameserver
+[Nn]ameservers
 [Nn]amespace
+[Nn]amespaces
 Node\.js
 npm
 nvm
@@ -123,8 +135,10 @@ Omnichannel
 optimisticReplicationThreshold
 PDF
 PLAIN authentication
+[Pp]luggable
 Pluggable Authentication Modules
 PAM
+[Pp]reload
 [Pp]rovisioned
 [Pp]rovisioning
 [Pp]rovisions
@@ -145,6 +159,7 @@ Read Committed
 [Rr]ebalancing
 [Rr]ebalances
 [Rr]ebase
+[Rr]eindex[ing]
 [Rr]epositories
 [Rr]eprovision
 [Rr]eprovisioned
@@ -164,11 +179,13 @@ Search quer[y|ies]
 Search Service
 Service Group
 Service Groups
-SGCollect
+sgcollect
 Spark Datasets
 [Ss]tartup
 Structured Streaming
 Sub-Document
+[Ss]ubquery
+[Ss]ubqueries
 sudo
 [Ss]wappiness
 TAP
@@ -192,13 +209,14 @@ UNNEST
 vBucket
 vBucketMap
 vBuckets
-VBucketServerMap
+vBucketServerMap
 Views Service
 [Vv]irtualization
 [Vv]irtualized
 vmstat
 VMware
 Vue
+[Ww]hitepaper
 X\.509
 XDCR
 XML

ValeStyles/config/vocabularies/Couchbase/reject.txt

@@ -3,9 +3,11 @@ and\/or
 back end
 (C\+\+)
 Columnar
+config
 Couchbase managed cloud
 data link
 data provider
+Forest DB
 mapreduce views
 map reduce views
 note that

styleguide/modules/ROOT/pages/alt-text.adoc

@@ -20,13 +20,13 @@ To write effective alt text:
 
 Describe, plainly, the content of the image.
 
-Imagine that you were trying to describe it to someone who couldn't actually see the image for themselves. 
+Imagine that you were trying to describe it to someone who could not actually see the image for themselves. 
 Write a meaningful description that suits the user's context.
 
 [#concise]
 == Be Concise 
 
-You don't need to describe every detail - unless there's important text that a user needs.
+You do not need to describe every detail - unless there's important text that a user needs.
 
 Give the most relevant, important details that a sighted user would get at a glance. 
 The alt text needs to provide this same information. 
@@ -37,17 +37,17 @@ The alt text needs to provide this same information.
 Make sure your alt text ends with a period after your last sentence. 
 
 [#image-of]
-== Don't Include "Image Of"
+== Do Not Include "Image Of"
 
-Don't start your alt text with the words "image of." 
+Do not start your alt text with the words `image of`.
 
 If you need to specify the type of image, such as a diagram or illustration, add that at the end of the alt text.
 
-Screen readers automatically add "image of."
+Screen readers automatically add `image of`.
 
 [#icons]
-== Don't Add Alt Text To Icons or Decorative Images
+== Do Not Add Alt Text To Icons or Decorative Images
 
-If the icon already has a text label, don't add alt text. 
+If the icon already has a text label, do not add alt text. 
 
-If the image is purely decorative and doesn't need to convey anything important to the user, don't add alt text.
+If the image is purely decorative and does not need to convey anything important to the user, do not add alt text.

styleguide/modules/ROOT/pages/anchor-links.adoc

@@ -2,7 +2,7 @@
 
 If you need to link to a specific place in a page, whether from another page or on the same page, use an anchor link. 
 
-NOTE: Don't rely on Antora's automatically generated anchor links. 
+NOTE: Do not rely on Antora's automatically generated anchor links. 
 If you need to use an anchor link, create your own. 
 This prevents broken links if header content changes. 
 
@@ -13,7 +13,7 @@ Aim for no more than 3-5 words maximum.
 * Make sure that your anchor links are unique across the page. 
 * Use all lowercase letters. 
 * Separate words with dashes. 
-* Don't add punctuation. 
+* Do not add punctuation. 
 
 For example, an anchor link for the heading *Generate API Keys* could be `[#generate-api-keys]`.
 

styleguide/modules/ROOT/pages/capitalization.adoc

@@ -21,4 +21,4 @@ Do not use all-uppercase letters except for official names, abbreviations, or re
 
 Do not use camel case, unless the name or code you're referencing uses it. 
 
-For capitalization rules for specific terms, refer to the xref:word-list.adoc[].
+For capitalization rules for specific terms, see the xref:word-list.adoc[].

styleguide/modules/ROOT/pages/colons.adoc

@@ -10,7 +10,8 @@ Use a colon to introduce an ordered or unordered list.
 
 == Semi-Colons
 
-Try to avoid using a semi-colon. In most cases, a period and a pair of shorter sentences is fine. 
+Try to avoid using a semi-colon.
+In most cases, a period and a pair of shorter sentences is fine. 
 
 If you're using a semi-colon to separate complex items in a list, just change the list to an ordered or unordered list. 
 

styleguide/modules/ROOT/pages/commas.adoc

@@ -2,6 +2,6 @@
 
 Use the Oxford comma for inline lists. 
 
-If an inline list has more than three items, consider using an xref:ordered-list[ordered] or xref:unordered-list.adoc[unordered] list, instead. 
+If an inline list has more than 3 items, consider using an xref:ordered-list[ordered] or xref:unordered-list.adoc[unordered] list, instead. 
 
-Vale flags sentences that use more than two commas as potential run-on sentences. 
+Vale flags sentences that use more than 2 commas as potential run-on sentences. 

styleguide/modules/ROOT/pages/contractions.adoc

@@ -1,7 +1,7 @@
 = Contractions 
 
-Contractions are combinations of at least two words. 
-A contraction is made by omitting one or more letters from one word and adding it to the end of another word. 
+Contractions are combinations of at least 2 words. 
+A contraction is made by omitting 1 or more letters from 1 word and adding it to the end of another word. 
 
 Many contractions combine a verb and a pronoun. 
 
@@ -15,7 +15,7 @@ For example, do not shorten `could not` to `couldn't`.
 
 == Do Not Use Informal Contractions
 
-Do not use informal contractions like "wanna" or "gonna".
+Do not use informal contractions like `wanna` or `gonna`.
 
 == Do Not Use Complex Contractions