diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 000000000..504e3fc40 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,5 @@ +StylesPath = .vale/styles +MinAlertLevel = suggestion + +[*.{md,qmd}] +BasedOnStyles = textbook diff --git a/.vale/config.ini b/.vale/config.ini new file mode 100644 index 000000000..bf5a9fcfb --- /dev/null +++ b/.vale/config.ini @@ -0,0 +1,6 @@ +StylesPath = styles +MinAlertLevel = suggestion + +[*.{md,qmd}] +#BasedOnStyles = textbook, write-good, proselint +BasedOnStyles = textbook, write-good diff --git a/.vale/styles/textbook/Capitalization.yml b/.vale/styles/textbook/Capitalization.yml new file mode 100644 index 000000000..8ea26954d --- /dev/null +++ b/.vale/styles/textbook/Capitalization.yml @@ -0,0 +1,6 @@ +extends: capitalization +message: "Use sentence case in section headings." +level: suggestion +scope: heading +match: $sentence + diff --git a/.vale/styles/textbook/OxfordComma.yml b/.vale/styles/textbook/OxfordComma.yml new file mode 100644 index 000000000..6b3aeb297 --- /dev/null +++ b/.vale/styles/textbook/OxfordComma.yml @@ -0,0 +1,9 @@ +extends: substitution +message: "Use the Oxford comma in lists for clarity." +level: suggestion +ignorecase: true +swap: + # Common pattern: list of three items without Oxford comma + '(\b\w+\b), (\b\w+\b) and (\b\w+\b)': '\1, \2, and \3' + + diff --git a/.vale/styles/textbook/Terminology.yml b/.vale/styles/textbook/Terminology.yml new file mode 100644 index 000000000..acd1ada1d --- /dev/null +++ b/.vale/styles/textbook/Terminology.yml @@ -0,0 +1,9 @@ +extends: substitution +message: "Use '{{suggestion}}' instead of '{{match}}' for consistency." +level: warning +ignorecase: true +swap: + latency: execution time + learning phase: training + hardware usage: resource utilization + neural network: machine learning system diff --git a/.vale/styles/textbook/Vocabulary.yml b/.vale/styles/textbook/Vocabulary.yml new file mode 100644 index 000000000..beb776744 --- /dev/null +++ b/.vale/styles/textbook/Vocabulary.yml @@ -0,0 +1,17 @@ +extends: substitution +message: "Avoid '{{match}}'; prefer '{{suggestion}}'." +level: warning +ignorecase: true +swap: + delve: analyze + underscore: emphasize + foster: support + facilitate: enable + leverage: use + holistic: comprehensive + pivotal: critical + nuanced: detailed + shed light on: explain + a myriad of: many + cutting-edge: modern + state-of-the-art: advanced