feat: starting point from Katapult dev docs & Vale config generator

.vale.ini

@@ -0,0 +1,19 @@
+StylesPath = styles
+
+MinAlertLevel = suggestion
+
+Packages = write-good, Readability
+
+Vocab = Krystal, Technical
+
+[*]
+BasedOnStyles = Vale, write-good, Readability
+
+[formats]
+mdx = md
+
+[*.md]
+# These rules exist to allow JSX /HTML in markdown files.
+BlockIgnores = (?s) *(<[^>]*>)
+BlockIgnores = (?s) *(import.*?\n)
+BlockIgnores = (?s) *(export.*?\))

styles/Krystal/Acronyms.yml

@@ -0,0 +1,29 @@
+extends: conditional
+message: "'%s' has no definition."
+link: 
+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
+  - CLI
+  - CPU
+  - FAQ
+  - GPU
+  - HTML
+  - HTTP
+  - HTTPS
+  - JSON
+  - PDF
+  - PHP
+  - RAM
+  - SSH
+  - SQL
+  - URL
+  - USB
+  - WHMCS
+  - YAML
+  - ZIP

styles/Krystal/Spelling.yml

@@ -0,0 +1,7 @@
+extends: spelling
+message: "Is '%s' spelled correctly? Is it missing code formatting?"
+level: error
+dictionaries:
+  - en_GB
+ignore:
+  - ignore/spelling-ignorelist.txt

styles/config/vocabularies/Krystal/accept.txt

@@ -0,0 +1,3 @@
+Katapult
+WHMCS
+Vue

styles/config/vocabularies/Technical/accept.txt

@@ -0,0 +1,321 @@
+[Aa]ccessor[s]?
+[Aa]llowlist[s]?
+[Aa]utocommit
+[Aa]utodeploy
+ACL[s]?
+[Aa]udiobook[s]?
+Algolia
+AMI[s]?
+Anchore
+Ansible
+API(|s|'s)?
+Aptfile
+arXiv
+Authy
+autofill
+Axios
+Backblaze
+balancer's
+[Bb]ackoff
+[Bb]lackhole(|s|d)
+[Bb]lackholing
+[Bb]lockchain
+[Bb]oolean
+[Bb]ootloader
+[Bb]uildpack[s]?
+[Bb]undler[s]?
+[Bb]ursty
+Bluehost
+Boto
+Btrfs
+[Bb]urstable
+byobu
+CA[s]?
+CCM(?:|s|'s)
+[Cc]odec(|s|'s)?
+[Cc]omposability
+[Cc]onfig
+[Cc]utover[s]?
+CDN[s]?
+Ceph
+Certbot
+cgroup[s]?
+chkrootkit
+ci
+CI
+CIDR[s]?
+Citrix
+CLI(|s|'s)?
+CNCF's
+Comodo
+Conda
+conformant
+containerd
+CoreDNS
+cPanel('s)?
+CPU[s]?
+CRD[s]?
+cron
+CSIDriver
+CVEs?
+Cyberduck
+Databricks
+Datadog
+data's
+[Dd]atacenter[s]?
+[Dd]atagram[s]?
+[Dd]eclaratively
+[Dd]enylist[s]?
+[Dd]ev
+Deepspeed
+DigiCert
+Dockerfile[s]?
+dockershim
+[Ee]gress(|es|ed|ing)
+[Ee]thernet
+Enom
+Esc
+ETag
+etcd
+Etherpad
+Fastly
+[Ff]ailover[s]?
+[Ff]irewalld
+FFmpeg(|'s)?
+Figma
+Filebase
+FileZilla
+Flexify
+FQDN[s]?
+Galera
+Gandi
+G[Bb]ps
+GBs
+gdown
+Gemfile
+[G]eospatial
+[Gg]eocod(e|er|ing)
+[Gg]ibibyte[s]?
+GIF
+GitHub
+Godep
+govendor
+GPG
+GPUs
+Grafana
+Graphcore
+Gunicorn
+gVisor
+HAProxy
+Hasura
+HDD[s]?
+Hetzner
+[Hh]ardcod(e|ed|ing)
+[Hh]ostname
+HPA[s]?
+(HTTP|http)
+(HTTPS|https)
+[Hh]yperparameters?
+Icinga
+[Ii]dempotence
+[Ii]mpactful
+Infiniband
+inode[s]?
+IP[s]?
+ISP[s]
+Istio
+iwantmyname
+Jamstack
+[Jj]ournaling
+journalctl
+JPG
+JWT
+Kaniko
+Kartograph
+keyspace
+Kibana
+[Kk]eepalive
+[Kk]ey pair[s]?
+[Kk]ubelet
+Knative
+Kourier
+Kube
+kubeconfig
+Kustomize
+Laravel
+Lerna
+LibriVox
+libvirt
+Lightsail
+Linkerd
+Linux
+[Ll]iveness
+[Ll]ockfile[s]?
+[Ll]ookup[s]?
+[Ll]oopback
+Logstash
+Logtail
+logtalez
+Lua
+[Mm]akefiles?
+matplotlib
+M[Bb]ps
+Megaport
+MLOps
+[Mm]icroarchitectur(?:e|al)
+[Mm]icroservice[s]
+MNIST
+MLOps
+[Mm]ulticloud
+MongoDB
+multiset[s]?
+MySQL
+Namecheap
+NAT[s]?
+netfilter
+Netplan
+[Nn]amespace
+[Nn]etmask[s]?
+npm
+NumPy
+NVLink
+NVMe
+OAuth
+Okta
+OmniAuth
+Omnis
+Ooma
+[Oo]nboarding
+[Oo]nnx
+OS
+ownCloud
+Papertrail
+PayPal
+PDF(|s|'s)?
+pgAdmin
+PgBouncer
+Pgpool
+pgRouting
+plaintext
+Plesk
+PNG
+Postgre(s|SQL)
+[Pp]arsable
+[Pp]asscode[s]?
+[Pp]assthrough
+[Pp]erformant
+[Pp]ooler
+[Pp]reauthorization
+[Pp]reconfigured?
+[Pp]refill[s]?
+[Pp]repend(|s|ed|ing)
+preload
+presigned
+Prisma
+psql
+Punycode
+PVC
+pydo
+qcow
+Rackspace
+Razer
+recommender
+Redis
+Redli
+Redsmin
+repo(s|'s)?
+resolver's
+reviewdog
+Rollup
+[Rr]clone
+[Rr]ebalancing
+[Rr]edeployment(s|'s)?
+[Rr]eenabl(e|ed|ing)
+[Rr]eprovision(|s|ed|ing)
+[Rr]ollout
+[Rr]outable
+[Rr]untime[s]?
+rsync
+Rsyslog
+safetensor[s]?
+Sarama
+SDK[s]?
+Skylake
+SLA[s]?
+Slowloris
+Snyk
+Sourcegraph
+SSD[s]?
+[Ss]erializable
+[Ss]erverless
+ssh-copy-id
+[Ss]hortcode[s]?
+[Ss]ubcommand[s]?
+[Ss]ubfolder[s]?
+[Ss]ubnet(|s|work|works)
+Streamlit
+sudo
+Supabase
+SVG
+syslog
+systemd
+Tekton
+Terraform
+TLD[s]
+tmux
+traceroute
+Trilio
+[Tt]axability
+[Tt]emplated
+TTL
+[Tt]oolchain[s]?
+[Tt]ooltip
+Twilio
+tz
+UI
+uninstallation
+UpCloud
+upsert[s]
+URI
+URL
+UUID[s]?
+[Uu]nassign(|s|ed)
+[Uu]ncheck
+[Uu]ncomment(|ed)
+[Uu]ncompromised
+[Uu]ndeploy(|ed)
+[Uu]nderuse
+[Uu]nencrypted
+[Uu]nformatted
+[Uu]nmanaged
+[Uu]nmarshal(|led|ling)
+[Uu]nmetered
+[Uu]nmount
+[Uu]npartitioned
+[Uu]npatched
+[Uu]nsetting
+[Uu]nstage(|s|ed|ing)
+[Uu]ntriggered
+[Uu]ntrusted
+[Uu]nversioned
+VDI[s]?
+Velero
+Vidhya
+virtualenv
+VM[s]?
+VMware
+vnStat
+VPC[s]?
+VPN[s]?
+Vultr
+[Vv]irtualized
+WebSocket
+Wget
+Wikidata
+WordPress
+[Ww]ebpack
+Xeon
+xrdp
+YAML
+Zombieload
+[Zz]sh