From 8a5b878e45d8f5d59938a204ed1e0aba728e3cec Mon Sep 17 00:00:00 2001
From: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Date: Fri, 20 Sep 2024 10:52:08 -0400
Subject: [PATCH] reorganizes accept vs ignore lists for polkadot vocab to make
 it more effective (#15)

---
 .github/styles/Papermoon/Acronyms.yml         |  3 +++
 .github/styles/Papermoon/CustomDictionary.yml |  3 +++
 .github/styles/Papermoon/NotContractions.yml  |  2 +-
 .github/styles/Papermoon/WordSwapList.yml     |  5 ++++
 .github/styles/config/Papermoon.yml           | 10 +++----
 .../config/ignore/brand-token-ignore.txt      |  3 +++
 .../styles/config/ignore/polkadot-ignore.txt  | 26 +++++++++++++++++++
 .../config/vocabularies/Industry/accept.txt   | 12 +++++++--
 .../config/vocabularies/Papermoon/accept.txt  |  1 +
 .../config/vocabularies/Papermoon/reject.txt  |  3 ---
 .../config/vocabularies/Polkadot/accept.txt   |  4 +--
 polkadot-docs                                 |  1 +
 12 files changed, 59 insertions(+), 14 deletions(-)
 create mode 100644 .github/styles/config/ignore/polkadot-ignore.txt
 create mode 160000 polkadot-docs

diff --git a/.github/styles/Papermoon/Acronyms.yml b/.github/styles/Papermoon/Acronyms.yml
index bac22756..47e9ea68 100644
--- a/.github/styles/Papermoon/Acronyms.yml
+++ b/.github/styles/Papermoon/Acronyms.yml
@@ -15,6 +15,7 @@ exceptions:
   - CSS
   - CSV
   - DEBUG
+  - DNS
   - DOM
   - DPI
   - EVM
@@ -47,6 +48,7 @@ exceptions:
   - RPC
   - RPM
   - RSA
+  - SCALE
   - SCM
   - SCSS
   - SDK
@@ -63,6 +65,7 @@ exceptions:
   - URL
   - USB
   - UTF
+  - WSS
   - XCM
   - XML
   - XSS
diff --git a/.github/styles/Papermoon/CustomDictionary.yml b/.github/styles/Papermoon/CustomDictionary.yml
index f9f5668b..90538027 100644
--- a/.github/styles/Papermoon/CustomDictionary.yml
+++ b/.github/styles/Papermoon/CustomDictionary.yml
@@ -8,4 +8,7 @@ ignore:
   # Reference file location relative to styles/config/ignore directory
     # custom dictionary of cyrpto brands and token names/symbols
   - brand-token-ignore.txt
+    # case insensitive list of polkadot related words
+  - polkadot-ignore.txt
+  
     
diff --git a/.github/styles/Papermoon/NotContractions.yml b/.github/styles/Papermoon/NotContractions.yml
index 1fa0b952..570ea788 100644
--- a/.github/styles/Papermoon/NotContractions.yml
+++ b/.github/styles/Papermoon/NotContractions.yml
@@ -1,5 +1,5 @@
 extends: substitution
-message: "Use '%s' instead of '%s'."
+message: "Use '%s' instead of '%s' to improve clarity for the reader"
 link: 'https://developers.google.com/style/contractions'
 level: suggestion
 ignorecase: true
diff --git a/.github/styles/Papermoon/WordSwapList.yml b/.github/styles/Papermoon/WordSwapList.yml
index fae070ee..63951ab4 100644
--- a/.github/styles/Papermoon/WordSwapList.yml
+++ b/.github/styles/Papermoon/WordSwapList.yml
@@ -19,16 +19,21 @@ swap:
   a\.k\.a|aka: or|also known as
   approx\.: approximately
   check box: checkbox
+  config: configuration
   disabled?: turn off|off|deactivate
   file name: filename
   HTTPs: HTTPS
   in order to: to
+  Nginx: nginx|NGINX
   open-source: open source
   "(?:Polkadot JS|Polkadot.Js|Polkadot.JS)": Polkadot.js
+  "(?:repo|repos)": repository|repositories
+  rpc: RPC
   stylesheet: style sheet
   tablename: table name
   url: URL
   vs\.: versus
+  whitelist: allowlist 
   wasm: Wasm
   
   
\ No newline at end of file
diff --git a/.github/styles/config/Papermoon.yml b/.github/styles/config/Papermoon.yml
index 2250ce2d..a0f2cc7f 100644
--- a/.github/styles/config/Papermoon.yml
+++ b/.github/styles/config/Papermoon.yml
@@ -1,9 +1,9 @@
-name: Papermoon
-description: "Custom style guide for enforcing Papermoon standards."
+name: PaperMoon
+description: "Custom style guide for enforcing PaperMoon standards."
 version: 0.1.0
 rules:
 
-  ### ALERT Level = Error (commit will fail) ###
+  ### ALERT Level = Error ###
 
   # Extends Vale dictionary to reference ignore files for customization
   CustomDictionary: error
@@ -13,13 +13,13 @@ rules:
   Titlecase.yml: error
 
 
-  ### ALERT Level = Warning (commit will succeed) ###
+  ### ALERT Level = Warning ###
 
   # Enforces custom version of Google.WordList
   WordSwapList.yml: warning
 
 
-  ### ALERT Level = Suggestion (commit will succeed) ###
+  ### ALERT Level = Suggestion ###
 
   # Prompts user to spell out unfamiliar acronyms first time they are used
   # Includes exception list to specify acronyms this rule will ignore
diff --git a/.github/styles/config/ignore/brand-token-ignore.txt b/.github/styles/config/ignore/brand-token-ignore.txt
index 643f8912..426853ae 100644
--- a/.github/styles/config/ignore/brand-token-ignore.txt
+++ b/.github/styles/config/ignore/brand-token-ignore.txt
@@ -7,6 +7,7 @@ Astar
 Celo
 CELO
 Ethereum
+ETH
 Grafana
 Klaytn
 Kujira
@@ -15,6 +16,8 @@ Moonbeam
 Moonriver
 Moonbase Alpha
 Polkadot
+Rococo
+ROC
 Sei
 Solana
 Uniswap
diff --git a/.github/styles/config/ignore/polkadot-ignore.txt b/.github/styles/config/ignore/polkadot-ignore.txt
new file mode 100644
index 00000000..6ca85342
--- /dev/null
+++ b/.github/styles/config/ignore/polkadot-ignore.txt
@@ -0,0 +1,26 @@
+args
+backchannel
+blockHash
+bootnode
+bootnodes
+composable
+coretime
+dispatchable
+extrinsics
+forkless
+inherents
+invulnerables
+liveness
+multilocation
+omninode
+parachain
+parachain's
+parachains
+parathread
+relay chain
+relay chains
+runtimes
+Smoldot
+solochain
+subxt
+sudo
\ No newline at end of file
diff --git a/.github/styles/config/vocabularies/Industry/accept.txt b/.github/styles/config/vocabularies/Industry/accept.txt
index f2b51eac..a3c317b2 100644
--- a/.github/styles/config/vocabularies/Industry/accept.txt
+++ b/.github/styles/config/vocabularies/Industry/accept.txt
@@ -14,12 +14,13 @@ Etherscan
 EVM 
 EVMs
 Ethereum
+hardcoded
 href
 Injective
 JavaScript
 JSON-RPC
-keystore
-keystores
+[Kk]eystore
+[Kk]eystores
 Merkle
 mintable
 multisig
@@ -27,6 +28,7 @@ namespace
 namespaces
 Nano
 [Nn]ominable
+nginx
 npm
 npx
 onboarded
@@ -34,9 +36,12 @@ onboarding
 permissionless
 picosecond
 Podman
+Prometheus
 [Pp]rometheus
 promtool
 Protobuf
+proxied
+proxying
 runbooks
 SDK
 snake_case
@@ -51,8 +56,11 @@ UI
 UIs
 [Vv]alidator
 [Vv]alidators
+virtualhost
 Wasm
 webRTC
+[Ww]ebsocket
+[Ww]ebsockets
 
 
 
diff --git a/.github/styles/config/vocabularies/Papermoon/accept.txt b/.github/styles/config/vocabularies/Papermoon/accept.txt
index f555d9ce..41c5175a 100644
--- a/.github/styles/config/vocabularies/Papermoon/accept.txt
+++ b/.github/styles/config/vocabularies/Papermoon/accept.txt
@@ -1,4 +1,5 @@
 MainNet
+PaperMoon
 TestNet
 time frame
 
diff --git a/.github/styles/config/vocabularies/Papermoon/reject.txt b/.github/styles/config/vocabularies/Papermoon/reject.txt
index a93a6dce..b3ce6281 100644
--- a/.github/styles/config/vocabularies/Papermoon/reject.txt
+++ b/.github/styles/config/vocabularies/Papermoon/reject.txt
@@ -3,10 +3,7 @@ her
 hers
 him
 his
-let's
-our
 she
-we
 
 
 
diff --git a/.github/styles/config/vocabularies/Polkadot/accept.txt b/.github/styles/config/vocabularies/Polkadot/accept.txt
index 47276456..c777dc12 100644
--- a/.github/styles/config/vocabularies/Polkadot/accept.txt
+++ b/.github/styles/config/vocabularies/Polkadot/accept.txt
@@ -17,8 +17,6 @@ dev_newBlock
 dev_setHead
 dev_setStorage
 dev_timeTravel
-[Dd]ispatchable
-[Ee]xtrinsics
 Ferdie
 [Ff]orkless
 FRAME
@@ -52,6 +50,7 @@ Polkadot
 Polkadot OpenGov
 Polkadot's
 Polkadot SDK
+Polkassembly
 [Rr]ebond
 referenda
 [Pr]eimage
@@ -60,7 +59,6 @@ referenda
 relay chain
 relay chains
 Rococo
-[Rr]untimes
 Shiden
 Smoldot
 Snowbridge
diff --git a/polkadot-docs b/polkadot-docs
new file mode 160000
index 00000000..9296668d
--- /dev/null
+++ b/polkadot-docs
@@ -0,0 +1 @@
+Subproject commit 9296668d9776344f8565de27860d30855bb461ec