Merge branch 'main' into enhance/design-feature

.vale copy.ini

@@ -0,0 +1,12 @@
+# Vale configuration file.
+#
+# For more information, see https://errata-ai.gitbook.io/vale/getting-started/configuration.
+
+StylesPath = /.vale
+MinAlertLevel = suggestion
+
+[*.md]
+BasedOnStyles = thothtech
+
+# Ignore SVG markup
+TokenIgnores = (\*\*\{\w*\}\*\*)

.vale/thothtech/Admin.yml

@@ -0,0 +1,15 @@
+---
+# Warning: thothtech.Admin
+#
+# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message:
+  'Verify this use of the word "admin". Can it be updated to "administration", "administrator",
+  "administer", or "Admin Area"?'
+link: TBA
+level: suggestion
+ignorecase: false
+swap:
+  '[Aa]dmin ?\w*': "(?:Admin( Area| Mode)?|[Aa]dminist(ration|rator|rators|er|rative))"

.vale/thothtech/American.yml

@@ -0,0 +1,107 @@
+---
+# Error: thothtech.American
+#
+# Checks that British spelling is used instead of American spelling.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use the British spelling "%s" instead of the American "%s".'
+link: TBA
+level: error
+ignorecase: true
+swap:
+  eon: aeon
+  airplane: aeroplane
+  aging: ageing
+  aluminum: aluminium
+  anemia: anaemia
+  anesthesia: anaesthesia
+  analyze: analyse
+  annex: annexe
+  apologize: apologise
+  authorize: authorise
+  authorized: authorised
+  authorization: authorisation
+  authorizing: authorising
+  behavior: behaviour
+  buses: busses
+  caliber: calibre
+  categorize: categorise
+  categorized: categorised
+  categorizes: categorises
+  categorizing: categorising
+  center: centre
+  civilization: civilisation
+  civilize: civilise
+  color: colour
+  cozy: cosy
+  defense: defence
+  distill: distil
+  encyclopedia: encyclopaedia
+  inquiry: enquiry
+  enroll: enrol
+  enrollment: enrolment
+  enthrall: enthral
+  favorite: favourite
+  fiber: fibre
+  filet: fillet
+  flavor: flavour
+  furor: furore
+  fulfill: fulfil
+  gray: grey
+  humor: humour
+  honor: honour
+  initialed: initialled
+  initialing: initialling
+  instill: instil
+  jewelry: jewellery
+  labeling: labelling
+  labeled: labelled
+  labor: labour
+  libelous: libellous
+  license: licence
+  likable: likeable
+  livable: liveable
+  luster: lustre
+  maneuver: manoeuvre
+  marvelous: marvellous
+  meager: meagre
+  meter: metre
+  modeling: modelling
+  mustache: moustache
+  neighbor: neighbour
+  normalize: normalise
+  offense: offence
+  organize: organise
+  paralyze: paralyse
+  plow: plough
+  pretense: pretence
+  pajamas: pyjamas
+  ratable: rateable
+  realize: realise
+  recognize: recognise
+  reconnoiter: reconnoitre
+  rumor: rumour
+  saber: sabre
+  salable: saleable
+  saltpeter: saltpetre
+  skeptic: sceptic
+  sepulcher: sepulchre
+  signaling: signalling
+  sizable: sizeable
+  skillful: skilful
+  somber: sombre
+  smolder: smoulder
+  specialty: speciality
+  specter: spectre
+  splendor: splendour
+  standardize: standardise
+  standardized: standardised
+  sulfur: sulphur
+  theater: theatre
+  traveled: travelled
+  traveler: traveller
+  traveling: travelling
+  unshakable: unshakeable
+  willful: wilful
+  yogurt: yoghurt

.vale/thothtech/BadPlurals.yml

@@ -0,0 +1,14 @@
+---
+# Suggestion: thothtech.BadPlurals
+#
+# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable.
+#
+# For a list of all options, see https://docs.errata.ai/vale/styles
+extends: existence
+message: 'Rewrite "%s" to be plural, without parentheses.'
+link: TBA
+level: warning
+scope: raw
+ignorecase: true
+raw:
+  - '\w*\(s\)(?<!http\(s\))'

.vale/thothtech/CodeblockFences.yml

@@ -0,0 +1,15 @@
+---
+# Error: thothtech.CodeblockFences
+#
+# Ensures all codeblock language tags use the full name, not aliases.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message:
+  'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell,
+  golang, python, dockerfile, or typescript.'
+link: TBA
+level: error
+scope: raw
+raw:
+  - '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|go\n|py\n|docker\n|ts)'

.vale/thothtech/CurrentStatus.yml

@@ -0,0 +1,16 @@
+---
+# Suggestion: thothtech.CurrentStatus
+#
+# Checks for words that indicate a product or feature may change in the future.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message:
+  'Avoid words like "%s" when you write about future features. Our documentation is about the
+  current state of the product.'
+level: suggestion
+ignorecase: true
+link: TBA
+tokens:
+  - currently
+  - yet

.vale/thothtech/DefaultBranch.yml

@@ -0,0 +1,14 @@
+---
+# Warning: thothtech.DefaultBranch
+#
+# Do not refer to the default branch as the "master" branch, if possible.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Use "default branch" or `main` instead of `master`, when possible.'
+level: warning
+ignorecase: true
+link: TBA
+scope: raw
+raw:
+  - '\`master\`'

.vale/thothtech/FirstPerson.yml

@@ -0,0 +1,18 @@
+---
+# Warning: thothtech.FirstPerson
+#
+# Checks for use of first person pronouns.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message:
+  '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one)
+  instead.'
+level: warning
+ignorecase: true
+link: TBA
+tokens:
+  - '\bI[ ,;:?!"]|\bI\x27.{1,2}'
+  - me
+  - myself
+  - mine

.vale/thothtech/FutureTense.yml

@@ -0,0 +1,16 @@
+---
+# Suggestion: thothtech.FutureTense
+#
+# Checks for use of future tense in sentences. Present tense is strongly preferred.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Avoid using future tense: "%s". Use present tense instead.'
+ignorecase: true
+level: warning
+link: TBA
+raw:
+  - "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "will( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "won't( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)"

.vale/thothtech/HeadingContent.yml

@@ -0,0 +1,18 @@
+---
+# Error: thothtech.HeadingContent
+#
+# Checks for generic, unhelpful subheadings.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Rename the subheading "%s", or re-purpose the content elsewhere.'
+level: warning
+scope: heading
+link: TBA
+ignorecase: false
+tokens:
+  - How it works
+  - Limitations
+  - Overview
+  - Use cases?
+  - Important notes?

.vale/thothtech/InclusionAbleism.yml

@@ -0,0 +1,14 @@
+---
+# Suggestion: thothtech.InclusionAbleism
+#
+# Suggests alternatives for words that foster ableism.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use inclusive language. Consider "%s" instead of "%s".'
+link: TBA
+level: suggestion
+ignorecase: true
+swap:
+  sanity (?:check|test): check for completeness
+  dummy: placeholder, sample, fake

.vale/thothtech/InclusionCultural.yml

@@ -0,0 +1,17 @@
+---
+# Warning: thothtech.InclusionCultural
+#
+# Suggests alternatives for words that are culturally inappropriate.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use inclusive language. Consider "%s" instead of "%s".'
+link: TBA
+level: warning
+ignorecase: true
+swap:
+  blacklist(?:ed|ing|s)?: denylist
+  whitelist(?:ed|ing|s)?: allowlist
+  master: primary, main
+  slave: secondary
+  demilitarised zone: perimeter network

.vale/thothtech/InclusionGender.yml

@@ -0,0 +1,18 @@
+---
+# Suggestion: thothtech.InclusionGender
+#
+# Suggests alternatives for words that are gender-specific.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use inclusive language. Consider "%s" instead of "%s".'
+link: TBA
+level: suggestion
+ignorecase: true
+swap:
+  mankind: humanity, people
+  manpower: human effort, workforce
+  he: they
+  his: their
+  she: they
+  hers: their

.vale/thothtech/InternalLinkCase.yml

@@ -0,0 +1,13 @@
+---
+# Error: thothtech.InternalLinkCase
+#
+# Checks that anchor fragments on internal links are in lower-case.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Links to subheadings in Thoth Tech docs must be in lower-case: "%s"'
+link: TBA
+level: error
+scope: raw
+raw:
+  - '[^\`]\[[^\[\]]+\]\((https?:){0}[\w\/\.]*?#[^\s]*?[A-Z][^\) ]*\)[^\`]'

.vale/thothtech/InternalLinkExtension.yml

@@ -0,0 +1,13 @@
+---
+# Error: thothtech.InternalLinkExtension
+#
+# Checks that internal links have .md extenstion and not .html extension.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Link "%s" must use the .md file extension.'
+link: TBA
+level: error
+scope: raw
+raw:
+  - '\[.+\]\([\w\/\.-]+\.html[^)]*\)'

.vale/thothtech/InternalLinkFormat.yml

@@ -0,0 +1,13 @@
+---
+# Error: thothtech.InternalLinkFormat
+#
+# Checks that internal link paths don't start with "./", which is not needed.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Link "%s" must not start with "./".'
+link: TBA
+level: error
+scope: raw
+raw:
+  - '\[.+\]\(\.\/.*?\)'

.vale/thothtech/LatinTerms.yml

@@ -0,0 +1,17 @@
+---
+# Warning: thothtech.LatinTerms
+#
+# Checks for use of Latin terms.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use "%s" instead of "%s", but consider rewriting the sentence.'
+link: TBA
+level: warning
+nonword: true
+ignorecase: true
+swap:
+  e\.g\.: for example
+  e\. g\.: for example
+  i\.e\.: that is
+  i\. e\.: that is

.vale/thothtech/MeaningfulLinkWords.yml

@@ -0,0 +1,15 @@
+---
+# Warning: thothtech.MeaningfulLinkWords
+#
+# Checks for the presence of semantically unhelpful words in link text.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Improve SEO and accessibility by rewriting "%s" in the link text.'
+level: warning
+scope: link
+ignorecase: true
+link: TBA
+tokens:
+  - here
+  - this page

.vale/thothtech/MergeConflictMarkers.yml

@@ -0,0 +1,13 @@
+---
+# Error: thothtech.MergeConflictMarkers
+#
+# Checks for the presence of merge conflict markers.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Merge conflict marker "%s" found.'
+link: TBA
+level: error
+scope: raw
+raw:
+  - '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n'