From 696076995518c7170975cfc88e8c6bdd214424f8 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Mon, 11 Aug 2025 17:21:26 -0400 Subject: [PATCH 01/15] test --- .vale.ini | 4 +- .vale/styles/.vale-config/1-MDX.ini | 5 + .vale/styles/Microsoft/AMPM.yml | 9 + .vale/styles/Microsoft/Accessibility.yml | 30 ++ .vale/styles/Microsoft/Acronyms.yml | 64 +++++ .vale/styles/Microsoft/Adverbs.yml | 272 ++++++++++++++++++ .vale/styles/Microsoft/Auto.yml | 11 + .vale/styles/Microsoft/Avoid.yml | 14 + .vale/styles/Microsoft/Contractions.yml | 50 ++++ .vale/styles/Microsoft/Dashes.yml | 13 + .vale/styles/Microsoft/DateFormat.yml | 8 + .vale/styles/Microsoft/DateNumbers.yml | 40 +++ .vale/styles/Microsoft/DateOrder.yml | 8 + .vale/styles/Microsoft/Ellipses.yml | 9 + .vale/styles/Microsoft/FirstPerson.yml | 16 ++ .vale/styles/Microsoft/Foreign.yml | 13 + .vale/styles/Microsoft/Gender.yml | 8 + .vale/styles/Microsoft/GenderBias.yml | 42 +++ .vale/styles/Microsoft/GeneralURL.yml | 11 + .vale/styles/Microsoft/HeadingAcronyms.yml | 7 + .vale/styles/Microsoft/HeadingColons.yml | 8 + .vale/styles/Microsoft/HeadingPunctuation.yml | 13 + .vale/styles/Microsoft/Headings.yml | 28 ++ .vale/styles/Microsoft/Hyphens.yml | 14 + .vale/styles/Microsoft/Negative.yml | 13 + .vale/styles/Microsoft/Ordinal.yml | 13 + .vale/styles/Microsoft/OxfordComma.yml | 8 + .vale/styles/Microsoft/Passive.yml | 183 ++++++++++++ .vale/styles/Microsoft/Percentages.yml | 7 + .vale/styles/Microsoft/Plurals.yml | 7 + .vale/styles/Microsoft/Quotes.yml | 7 + .vale/styles/Microsoft/RangeTime.yml | 13 + .vale/styles/Microsoft/Semicolon.yml | 8 + .vale/styles/Microsoft/SentenceLength.yml | 7 + .vale/styles/Microsoft/Spacing.yml | 8 + .vale/styles/Microsoft/Suspended.yml | 7 + .vale/styles/Microsoft/Terms.yml | 42 +++ .vale/styles/Microsoft/URLFormat.yml | 9 + .vale/styles/Microsoft/Units.yml | 16 ++ .vale/styles/Microsoft/Vocab.yml | 25 ++ .vale/styles/Microsoft/We.yml | 11 + .vale/styles/Microsoft/Wordiness.yml | 127 ++++++++ .vale/styles/Microsoft/meta.json | 4 + .vale/styles/botpress-docs/passive-voice.yml | 10 - .../vocabularies/botpress-vocab/accept.txt | 25 +- .vscode/settings.json | 1 - learn/get-started/quick-start.mdx | 32 +-- 47 files changed, 1245 insertions(+), 35 deletions(-) create mode 100644 .vale/styles/.vale-config/1-MDX.ini create mode 100644 .vale/styles/Microsoft/AMPM.yml create mode 100644 .vale/styles/Microsoft/Accessibility.yml create mode 100644 .vale/styles/Microsoft/Acronyms.yml create mode 100644 .vale/styles/Microsoft/Adverbs.yml create mode 100644 .vale/styles/Microsoft/Auto.yml create mode 100644 .vale/styles/Microsoft/Avoid.yml create mode 100644 .vale/styles/Microsoft/Contractions.yml create mode 100644 .vale/styles/Microsoft/Dashes.yml create mode 100644 .vale/styles/Microsoft/DateFormat.yml create mode 100644 .vale/styles/Microsoft/DateNumbers.yml create mode 100644 .vale/styles/Microsoft/DateOrder.yml create mode 100644 .vale/styles/Microsoft/Ellipses.yml create mode 100644 .vale/styles/Microsoft/FirstPerson.yml create mode 100644 .vale/styles/Microsoft/Foreign.yml create mode 100644 .vale/styles/Microsoft/Gender.yml create mode 100644 .vale/styles/Microsoft/GenderBias.yml create mode 100644 .vale/styles/Microsoft/GeneralURL.yml create mode 100644 .vale/styles/Microsoft/HeadingAcronyms.yml create mode 100644 .vale/styles/Microsoft/HeadingColons.yml create mode 100644 .vale/styles/Microsoft/HeadingPunctuation.yml create mode 100644 .vale/styles/Microsoft/Headings.yml create mode 100644 .vale/styles/Microsoft/Hyphens.yml create mode 100644 .vale/styles/Microsoft/Negative.yml create mode 100644 .vale/styles/Microsoft/Ordinal.yml create mode 100644 .vale/styles/Microsoft/OxfordComma.yml create mode 100644 .vale/styles/Microsoft/Passive.yml create mode 100644 .vale/styles/Microsoft/Percentages.yml create mode 100644 .vale/styles/Microsoft/Plurals.yml create mode 100644 .vale/styles/Microsoft/Quotes.yml create mode 100644 .vale/styles/Microsoft/RangeTime.yml create mode 100644 .vale/styles/Microsoft/Semicolon.yml create mode 100644 .vale/styles/Microsoft/SentenceLength.yml create mode 100644 .vale/styles/Microsoft/Spacing.yml create mode 100644 .vale/styles/Microsoft/Suspended.yml create mode 100644 .vale/styles/Microsoft/Terms.yml create mode 100644 .vale/styles/Microsoft/URLFormat.yml create mode 100644 .vale/styles/Microsoft/Units.yml create mode 100644 .vale/styles/Microsoft/Vocab.yml create mode 100644 .vale/styles/Microsoft/We.yml create mode 100644 .vale/styles/Microsoft/Wordiness.yml create mode 100644 .vale/styles/Microsoft/meta.json delete mode 100644 .vale/styles/botpress-docs/passive-voice.yml diff --git a/.vale.ini b/.vale.ini index 692f26b6..fea1d611 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,10 +1,10 @@ StylesPath = .vale/styles - +Packages = Microsoft, MDX Vocab = botpress-vocab [formats] mdx = md [*.mdx] -BasedOnStyles = Vale, botpress-docs +BasedOnStyles = Vale, Microsoft, botpress-docs Markup = true \ No newline at end of file diff --git a/.vale/styles/.vale-config/1-MDX.ini b/.vale/styles/.vale-config/1-MDX.ini new file mode 100644 index 00000000..02ea72b3 --- /dev/null +++ b/.vale/styles/.vale-config/1-MDX.ini @@ -0,0 +1,5 @@ +[*.mdx] +# Exclude: +# +# - Non-JS inline expressions (which cause Acorn to throw) +TokenIgnores = '({#[^\n}]+})(?!`)' diff --git a/.vale/styles/Microsoft/AMPM.yml b/.vale/styles/Microsoft/AMPM.yml new file mode 100644 index 00000000..8b9fed16 --- /dev/null +++ b/.vale/styles/Microsoft/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: Use 'AM' or 'PM' (preceded by a space). +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.vale/styles/Microsoft/Accessibility.yml b/.vale/styles/Microsoft/Accessibility.yml new file mode 100644 index 00000000..f5f48293 --- /dev/null +++ b/.vale/styles/Microsoft/Accessibility.yml @@ -0,0 +1,30 @@ +extends: existence +message: "Don't use language (such as '%s') that defines people by their disability." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms +level: suggestion +ignorecase: true +tokens: + - a victim of + - able-bodied + - an epileptic + - birth defect + - crippled + - differently abled + - disabled + - dumb + - handicapped + - handicaps + - healthy person + - hearing-impaired + - lame + - maimed + - mentally handicapped + - missing a limb + - mute + - non-verbal + - normal person + - sight-impaired + - slow learner + - stricken with + - suffers from + - vision-impaired diff --git a/.vale/styles/Microsoft/Acronyms.yml b/.vale/styles/Microsoft/Acronyms.yml new file mode 100644 index 00000000..308ff7c0 --- /dev/null +++ b/.vale/styles/Microsoft/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "'%s' has no definition." +link: https://docs.microsoft.com/en-us/style-guide/acronyms +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 + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/.vale/styles/Microsoft/Adverbs.yml b/.vale/styles/Microsoft/Adverbs.yml new file mode 100644 index 00000000..5619f99d --- /dev/null +++ b/.vale/styles/Microsoft/Adverbs.yml @@ -0,0 +1,272 @@ +extends: existence +message: "Remove '%s' if it's not important to the meaning of the statement." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: warning +action: + name: remove +tokens: + - abnormally + - absentmindedly + - accidentally + - adventurously + - anxiously + - arrogantly + - awkwardly + - bashfully + - beautifully + - bitterly + - bleakly + - blindly + - blissfully + - boastfully + - boldly + - bravely + - briefly + - brightly + - briskly + - broadly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - cleverly + - closely + - coaxingly + - colorfully + - continually + - coolly + - courageously + - crossly + - cruelly + - curiously + - daintily + - dearly + - deceivingly + - deeply + - defiantly + - deliberately + - delightfully + - diligently + - dimly + - doubtfully + - dreamily + - easily + - effectively + - elegantly + - energetically + - enormously + - enthusiastically + - excitedly + - extremely + - fairly + - faithfully + - famously + - ferociously + - fervently + - fiercely + - fondly + - foolishly + - fortunately + - frankly + - frantically + - freely + - frenetically + - frightfully + - furiously + - generally + - generously + - gently + - gladly + - gleefully + - gracefully + - gratefully + - greatly + - greedily + - happily + - hastily + - healthily + - heavily + - helplessly + - honestly + - hopelessly + - hungrily + - innocently + - inquisitively + - intensely + - intently + - interestingly + - inwardly + - irritably + - jaggedly + - jealously + - jovially + - joyfully + - joyously + - jubilantly + - judgmentally + - justly + - keenly + - kiddingly + - kindheartedly + - knavishly + - knowingly + - knowledgeably + - lazily + - lightly + - limply + - lively + - loftily + - longingly + - loosely + - loudly + - lovingly + - loyally + - madly + - majestically + - meaningfully + - mechanically + - merrily + - miserably + - mockingly + - mortally + - mysteriously + - naturally + - nearly + - neatly + - nervously + - nicely + - noisily + - obediently + - obnoxiously + - oddly + - offensively + - optimistically + - overconfidently + - painfully + - partially + - patiently + - perfectly + - playfully + - politely + - poorly + - positively + - potentially + - powerfully + - promptly + - properly + - punctually + - quaintly + - queasily + - queerly + - questionably + - quickly + - quietly + - quirkily + - quite + - quizzically + - randomly + - rapidly + - rarely + - readily + - really + - reassuringly + - recklessly + - regularly + - reluctantly + - repeatedly + - reproachfully + - restfully + - righteously + - rightfully + - rigidly + - roughly + - rudely + - safely + - scarcely + - scarily + - searchingly + - sedately + - seemingly + - selfishly + - separately + - seriously + - shakily + - sharply + - sheepishly + - shrilly + - shyly + - silently + - sleepily + - slowly + - smoothly + - softly + - solemnly + - solidly + - speedily + - stealthily + - sternly + - strictly + - suddenly + - supposedly + - surprisingly + - suspiciously + - sweetly + - swiftly + - sympathetically + - tenderly + - tensely + - terribly + - thankfully + - thoroughly + - thoughtfully + - tightly + - tremendously + - triumphantly + - truthfully + - ultimately + - unabashedly + - unaccountably + - unbearably + - unethically + - unexpectedly + - unfortunately + - unimpressively + - unnaturally + - unnecessarily + - urgently + - usefully + - uselessly + - utterly + - vacantly + - vaguely + - vainly + - valiantly + - vastly + - verbally + - very + - viciously + - victoriously + - violently + - vivaciously + - voluntarily + - warmly + - weakly + - wearily + - wetly + - wholly + - wildly + - willfully + - wisely + - woefully + - wonderfully + - worriedly + - yawningly + - yearningly + - yieldingly + - youthfully + - zealously + - zestfully + - zestily diff --git a/.vale/styles/Microsoft/Auto.yml b/.vale/styles/Microsoft/Auto.yml new file mode 100644 index 00000000..4da43935 --- /dev/null +++ b/.vale/styles/Microsoft/Auto.yml @@ -0,0 +1,11 @@ +extends: existence +message: "In general, don't hyphenate '%s'." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto +ignorecase: true +level: error +action: + name: convert + params: + - simple +tokens: + - 'auto-\w+' diff --git a/.vale/styles/Microsoft/Avoid.yml b/.vale/styles/Microsoft/Avoid.yml new file mode 100644 index 00000000..dab7822c --- /dev/null +++ b/.vale/styles/Microsoft/Avoid.yml @@ -0,0 +1,14 @@ +extends: existence +message: "Don't use '%s'. See the A-Z word list for details." +# See the A-Z word list +link: https://docs.microsoft.com/en-us/style-guide +ignorecase: true +level: error +tokens: + - abortion + - and so on + - app(?:lication)?s? (?:developer|program) + - app(?:lication)? file + - backbone + - backend + - contiguous selection diff --git a/.vale/styles/Microsoft/Contractions.yml b/.vale/styles/Microsoft/Contractions.yml new file mode 100644 index 00000000..8c81dcbc --- /dev/null +++ b/.vale/styles/Microsoft/Contractions.yml @@ -0,0 +1,50 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions +level: error +ignorecase: true +action: + name: replace +swap: + are not: aren't + cannot: can't + could not: couldn't + did not: didn't + do not: don't + does not: doesn't + has not: hasn't + have not: haven't + how is: how's + is not: isn't + + 'it is(?!\.)': it's + 'it''s(?=\.)': it is + + should not: shouldn't + + "that is(?![.,])": that's + 'that''s(?=\.)': that is + + 'they are(?!\.)': they're + 'they''re(?=\.)': they are + + was not: wasn't + + 'we are(?!\.)': we're + 'we''re(?=\.)': we are + + 'we have(?!\.)': we've + 'we''ve(?=\.)': we have + + were not: weren't + + 'what is(?!\.)': what's + 'what''s(?=\.)': what is + + 'when is(?!\.)': when's + 'when''s(?=\.)': when is + + 'where is(?!\.)': where's + 'where''s(?=\.)': where is + + will not: won't diff --git a/.vale/styles/Microsoft/Dashes.yml b/.vale/styles/Microsoft/Dashes.yml new file mode 100644 index 00000000..72b05ba3 --- /dev/null +++ b/.vale/styles/Microsoft/Dashes.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Remove the spaces around '%s'." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes +ignorecase: true +nonword: true +level: error +action: + name: edit + params: + - trim + - " " +tokens: + - '\s[—–]\s|\s[—–]|[—–]\s' diff --git a/.vale/styles/Microsoft/DateFormat.yml b/.vale/styles/Microsoft/DateFormat.yml new file mode 100644 index 00000000..19653139 --- /dev/null +++ b/.vale/styles/Microsoft/DateFormat.yml @@ -0,0 +1,8 @@ +extends: existence +message: Use 'July 31, 2016' format, not '%s'. +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.vale/styles/Microsoft/DateNumbers.yml b/.vale/styles/Microsoft/DateNumbers.yml new file mode 100644 index 00000000..14d46747 --- /dev/null +++ b/.vale/styles/Microsoft/DateNumbers.yml @@ -0,0 +1,40 @@ +extends: existence +message: "Don't use ordinal numbers for dates." +link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates +level: error +nonword: true +ignorecase: true +raw: + - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* +tokens: + - first + - second + - third + - fourth + - fifth + - sixth + - seventh + - eighth + - ninth + - tenth + - eleventh + - twelfth + - thirteenth + - fourteenth + - fifteenth + - sixteenth + - seventeenth + - eighteenth + - nineteenth + - twentieth + - twenty-first + - twenty-second + - twenty-third + - twenty-fourth + - twenty-fifth + - twenty-sixth + - twenty-seventh + - twenty-eighth + - twenty-ninth + - thirtieth + - thirty-first diff --git a/.vale/styles/Microsoft/DateOrder.yml b/.vale/styles/Microsoft/DateOrder.yml new file mode 100644 index 00000000..12d69ba5 --- /dev/null +++ b/.vale/styles/Microsoft/DateOrder.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Always spell out the name of the month." +link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates +ignorecase: true +level: error +nonword: true +tokens: + - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/.vale/styles/Microsoft/Ellipses.yml b/.vale/styles/Microsoft/Ellipses.yml new file mode 100644 index 00000000..320457a8 --- /dev/null +++ b/.vale/styles/Microsoft/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/.vale/styles/Microsoft/FirstPerson.yml b/.vale/styles/Microsoft/FirstPerson.yml new file mode 100644 index 00000000..f58dea31 --- /dev/null +++ b/.vale/styles/Microsoft/FirstPerson.yml @@ -0,0 +1,16 @@ +extends: existence +message: "Use first person (such as '%s') sparingly." +link: https://docs.microsoft.com/en-us/style-guide/grammar/person +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I(?=\s) + - (?:^|\s)I(?=,\s) + - \bI'd\b + - \bI'll\b + - \bI'm\b + - \bI've\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/.vale/styles/Microsoft/Foreign.yml b/.vale/styles/Microsoft/Foreign.yml new file mode 100644 index 00000000..0d3d6002 --- /dev/null +++ b/.vale/styles/Microsoft/Foreign.yml @@ -0,0 +1,13 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)[\s,]': for example + '\b(?:ie|i\.e\.)[\s,]': that is + '\b(?:viz\.)[\s,]': namely + '\b(?:ergo)[\s,]': therefore diff --git a/.vale/styles/Microsoft/Gender.yml b/.vale/styles/Microsoft/Gender.yml new file mode 100644 index 00000000..47c08024 --- /dev/null +++ b/.vale/styles/Microsoft/Gender.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Don't use '%s'." +link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender +level: error +ignorecase: true +tokens: + - he/she + - s/he diff --git a/.vale/styles/Microsoft/GenderBias.yml b/.vale/styles/Microsoft/GenderBias.yml new file mode 100644 index 00000000..fc987b94 --- /dev/null +++ b/.vale/styles/Microsoft/GenderBias.yml @@ -0,0 +1,42 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.vale/styles/Microsoft/GeneralURL.yml b/.vale/styles/Microsoft/GeneralURL.yml new file mode 100644 index 00000000..dcef503d --- /dev/null +++ b/.vale/styles/Microsoft/GeneralURL.yml @@ -0,0 +1,11 @@ +extends: existence +message: "For a general audience, use 'address' rather than 'URL'." +link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses +level: warning +action: + name: replace + params: + - URL + - address +tokens: + - URL diff --git a/.vale/styles/Microsoft/HeadingAcronyms.yml b/.vale/styles/Microsoft/HeadingAcronyms.yml new file mode 100644 index 00000000..9dc3b6c2 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingAcronyms.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Avoid using acronyms in a title or heading." +link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings +level: warning +scope: heading +tokens: + - '[A-Z]{2,4}' diff --git a/.vale/styles/Microsoft/HeadingColons.yml b/.vale/styles/Microsoft/HeadingColons.yml new file mode 100644 index 00000000..7013c391 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingColons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Capitalize '%s'." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons +nonword: true +level: error +scope: heading +tokens: + - ':\s[a-z]' diff --git a/.vale/styles/Microsoft/HeadingPunctuation.yml b/.vale/styles/Microsoft/HeadingPunctuation.yml new file mode 100644 index 00000000..4954cb11 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't use end punctuation in headings." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - trim_right + - ".?!" +tokens: + - "[a-z][.?!]$" diff --git a/.vale/styles/Microsoft/Headings.yml b/.vale/styles/Microsoft/Headings.yml new file mode 100644 index 00000000..63624edc --- /dev/null +++ b/.vale/styles/Microsoft/Headings.yml @@ -0,0 +1,28 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: https://docs.microsoft.com/en-us/style-guide/capitalization +level: suggestion +scope: heading +match: $sentence +indicators: + - ':' +exceptions: + - Azure + - CLI + - Code + - Cosmos + - Docker + - Emmet + - I + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - REPL + - Studio + - TypeScript + - URLs + - Visual + - VS + - Windows diff --git a/.vale/styles/Microsoft/Hyphens.yml b/.vale/styles/Microsoft/Hyphens.yml new file mode 100644 index 00000000..7e5731c9 --- /dev/null +++ b/.vale/styles/Microsoft/Hyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens +level: warning +ignorecase: false +nonword: true +action: + name: edit + params: + - regex + - "-" + - " " +tokens: + - '\b[^\s-]+ly-\w+\b' diff --git a/.vale/styles/Microsoft/Negative.yml b/.vale/styles/Microsoft/Negative.yml new file mode 100644 index 00000000..d73221f5 --- /dev/null +++ b/.vale/styles/Microsoft/Negative.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Form a negative number with an en dash, not a hyphen." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +action: + name: edit + params: + - regex + - "-" + - "–" +tokens: + - '(?<=\s)-\d+(?:\.\d+)?\b' diff --git a/.vale/styles/Microsoft/Ordinal.yml b/.vale/styles/Microsoft/Ordinal.yml new file mode 100644 index 00000000..e3483e38 --- /dev/null +++ b/.vale/styles/Microsoft/Ordinal.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't add -ly to an ordinal number." +link: https://docs.microsoft.com/en-us/style-guide/numbers +level: error +action: + name: edit + params: + - trim + - ly +tokens: + - firstly + - secondly + - thirdly diff --git a/.vale/styles/Microsoft/OxfordComma.yml b/.vale/styles/Microsoft/OxfordComma.yml new file mode 100644 index 00000000..493b55c3 --- /dev/null +++ b/.vale/styles/Microsoft/OxfordComma.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas +scope: sentence +level: suggestion +nonword: true +tokens: + - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/.vale/styles/Microsoft/Passive.yml b/.vale/styles/Microsoft/Passive.yml new file mode 100644 index 00000000..102d377c --- /dev/null +++ b/.vale/styles/Microsoft/Passive.yml @@ -0,0 +1,183 @@ +extends: existence +message: "'%s' looks like passive voice." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/.vale/styles/Microsoft/Percentages.yml b/.vale/styles/Microsoft/Percentages.yml new file mode 100644 index 00000000..b68a7363 --- /dev/null +++ b/.vale/styles/Microsoft/Percentages.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use a numeral plus the units." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +tokens: + - '\b[a-zA-z]+\spercent\b' diff --git a/.vale/styles/Microsoft/Plurals.yml b/.vale/styles/Microsoft/Plurals.yml new file mode 100644 index 00000000..1bb6660a --- /dev/null +++ b/.vale/styles/Microsoft/Plurals.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add '%s' to a singular noun. Use plural instead." +ignorecase: true +level: error +link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/s/s-es +raw: + - '\(s\)|\(es\)' diff --git a/.vale/styles/Microsoft/Quotes.yml b/.vale/styles/Microsoft/Quotes.yml new file mode 100644 index 00000000..38f49760 --- /dev/null +++ b/.vale/styles/Microsoft/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: 'Punctuation should be inside the quotes.' +link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks +level: error +nonword: true +tokens: + - '["“][^"”“]+["”][.,]' diff --git a/.vale/styles/Microsoft/RangeTime.yml b/.vale/styles/Microsoft/RangeTime.yml new file mode 100644 index 00000000..72d8bbfb --- /dev/null +++ b/.vale/styles/Microsoft/RangeTime.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use 'to' instead of a dash in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +action: + name: edit + params: + - regex + - "[-–]" + - "to" +tokens: + - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/.vale/styles/Microsoft/Semicolon.yml b/.vale/styles/Microsoft/Semicolon.yml new file mode 100644 index 00000000..4d905467 --- /dev/null +++ b/.vale/styles/Microsoft/Semicolon.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Try to simplify this sentence." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/.vale/styles/Microsoft/SentenceLength.yml b/.vale/styles/Microsoft/SentenceLength.yml new file mode 100644 index 00000000..f248cf05 --- /dev/null +++ b/.vale/styles/Microsoft/SentenceLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Try to keep sentences short (< 30 words)." +scope: sentence +level: suggestion +max: 30 +token: \b(\w+)\b + diff --git a/.vale/styles/Microsoft/Spacing.yml b/.vale/styles/Microsoft/Spacing.yml new file mode 100644 index 00000000..bbd10e51 --- /dev/null +++ b/.vale/styles/Microsoft/Spacing.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should have one space." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods +level: error +nonword: true +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/.vale/styles/Microsoft/Suspended.yml b/.vale/styles/Microsoft/Suspended.yml new file mode 100644 index 00000000..7282e9c9 --- /dev/null +++ b/.vale/styles/Microsoft/Suspended.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use '%s' unless space is limited." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens +ignorecase: true +level: warning +tokens: + - '\w+- and \w+-' diff --git a/.vale/styles/Microsoft/Terms.yml b/.vale/styles/Microsoft/Terms.yml new file mode 100644 index 00000000..65fca10a --- /dev/null +++ b/.vale/styles/Microsoft/Terms.yml @@ -0,0 +1,42 @@ +extends: substitution +message: "Prefer '%s' over '%s'." +# term preference should be based on microsoft style guide, such as +link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/adapter +level: warning +ignorecase: true +action: + name: replace +swap: + "(?:agent|virtual assistant|intelligent personal assistant)": personal digital assistant + "(?:assembler|machine language)": assembly language + "(?:drive C:|drive C>|C: drive)": drive C + "(?:internet bot|web robot)s?": bot(s) + "(?:microsoft cloud|the cloud)": cloud + "(?:mobile|smart) ?phone": phone + "24/7": every day + "audio(?:-| )book": audiobook + "back(?:-| )light": backlight + "chat ?bots?": chatbot(s) + adaptor: adapter + administrate: administer + afterwards: afterward + alphabetic: alphabetical + alphanumerical: alphanumeric + an URL: a URL + anti-aliasing: antialiasing + anti-malware: antimalware + anti-spyware: antispyware + anti-virus: antivirus + appendixes: appendices + artificial intelligence: AI + caap: CaaP + conversation-as-a-platform: conversation as a platform + eb: EB + gb: GB + gbps: Gbps + kb: KB + keypress: keystroke + mb: MB + pb: PB + tb: TB + zb: ZB diff --git a/.vale/styles/Microsoft/URLFormat.yml b/.vale/styles/Microsoft/URLFormat.yml new file mode 100644 index 00000000..4e24aa59 --- /dev/null +++ b/.vale/styles/Microsoft/URLFormat.yml @@ -0,0 +1,9 @@ +extends: substitution +message: Use 'of' (not 'for') to describe the relationship of the word URL to a resource. +ignorecase: true +link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/u/url +level: suggestion +action: + name: replace +swap: + URL for: URL of diff --git a/.vale/styles/Microsoft/Units.yml b/.vale/styles/Microsoft/Units.yml new file mode 100644 index 00000000..f062418e --- /dev/null +++ b/.vale/styles/Microsoft/Units.yml @@ -0,0 +1,16 @@ +extends: existence +message: "Don't spell out the number in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms +level: error +raw: + - '[a-zA-Z]+\s' +tokens: + - '(?:centi|milli)?meters' + - '(?:kilo)?grams' + - '(?:kilo)?meters' + - '(?:mega)?pixels' + - cm + - inches + - lb + - miles + - pounds diff --git a/.vale/styles/Microsoft/Vocab.yml b/.vale/styles/Microsoft/Vocab.yml new file mode 100644 index 00000000..eebe97b1 --- /dev/null +++ b/.vale/styles/Microsoft/Vocab.yml @@ -0,0 +1,25 @@ +extends: existence +message: "Verify your use of '%s' with the A-Z word list." +link: 'https://docs.microsoft.com/en-us/style-guide' +level: suggestion +ignorecase: true +tokens: + - above + - accessible + - actionable + - against + - alarm + - alert + - alias + - allows? + - and/or + - as well as + - assure + - author + - avg + - beta + - ensure + - he + - insure + - sample + - she diff --git a/.vale/styles/Microsoft/We.yml b/.vale/styles/Microsoft/We.yml new file mode 100644 index 00000000..97c901c1 --- /dev/null +++ b/.vale/styles/Microsoft/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/.vale/styles/Microsoft/Wordiness.yml b/.vale/styles/Microsoft/Wordiness.yml new file mode 100644 index 00000000..8a4fea74 --- /dev/null +++ b/.vale/styles/Microsoft/Wordiness.yml @@ -0,0 +1,127 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: suggestion +action: + name: replace +swap: + "sufficient number(?: of)?": enough + (?:extract|take away|eliminate): remove + (?:in order to|as a means to): to + (?:inform|let me know): tell + (?:previous|prior) to: before + (?:utilize|make use of): use + a (?:large)? majority of: most + a (?:large)? number of: many + a myriad of: myriad + adversely impact: hurt + all across: across + all of a sudden: suddenly + all of these: these + all of(?! a sudden| these): all + all-time record: record + almost all: most + almost never: seldom + along the lines of: similar to + an adequate number of: enough + an appreciable number of: many + an estimated: about + any and all: all + are in agreement: agree + as a matter of fact: in fact + as a means of: to + as a result of: because of + as of yet: yet + as per: per + at a later date: later + at all times: always + at the present time: now + at this point in time: at this point + based in large part on: based on + based on the fact that: because + basic necessity: necessity + because of the fact that: because + came to a realization: realized + came to an abrupt end: ended abruptly + carry out an evaluation of: evaluate + close down: close + closed down: closed + complete stranger: stranger + completely separate: separate + concerning the matter of: regarding + conduct a review of: review + conduct an investigation: investigate + conduct experiments: experiment + continue on: continue + despite the fact that: although + disappear from sight: disappear + doomed to fail: doomed + drag and drop: drag + drag-and-drop: drag + due to the fact that: because + during the period of: during + during the time that: while + emergency situation: emergency + establish connectivity: connect + except when: unless + excessive number: too many + extend an invitation: invite + fall down: fall + fell down: fell + for the duration of: during + gather together: gather + has the ability to: can + has the capacity to: can + has the opportunity to: could + hold a meeting: meet + if this is not the case: if not + in a careful manner: carefully + in a thoughtful manner: thoughtfully + in a timely manner: timely + in addition: also + in an effort to: to + in between: between + in lieu of: instead of + in many cases: often + in most cases: usually + in order to: to + in some cases: sometimes + in spite of the fact that: although + in spite of: despite + in the (?:very)? near future: soon + in the event that: if + in the neighborhood of: roughly + in the vicinity of: close to + it would appear that: apparently + lift up: lift + made reference to: referred to + make reference to: refer to + mix together: mix + none at all: none + not in a position to: unable + not possible: impossible + of major importance: important + perform an assessment of: assess + pertaining to: about + place an order: order + plays a key role in: is essential to + present time: now + readily apparent: apparent + some of the: some + span across: span + subsequent to: after + successfully complete: complete + take action: act + take into account: consider + the question as to whether: whether + there is no doubt but that: doubtless + this day and age: this age + this is a subject that: this subject + time (?:frame|period): time + under the provisions of: under + until such time as: until + used for fuel purposes: used for fuel + whether or not: whether + with regard to: regarding + with the exception of: except for diff --git a/.vale/styles/Microsoft/meta.json b/.vale/styles/Microsoft/meta.json new file mode 100644 index 00000000..297719bb --- /dev/null +++ b/.vale/styles/Microsoft/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Microsoft/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.vale/styles/botpress-docs/passive-voice.yml b/.vale/styles/botpress-docs/passive-voice.yml deleted file mode 100644 index 79b7fdcb..00000000 --- a/.vale/styles/botpress-docs/passive-voice.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "Consider using active voice if possible. Who/what is performing this action?" -level: warning -tokens: - - '\bcan(?:\s+\w+)*\s+be\s+\w+ed\b' - - '\bis(?:\s+\w+)*\s+\w+ed\b' - - '\bshould(?:\s+\w+)*\s+be\s+\w+ed\b' - - '\bmay(?:\s+\w+)*\s+be\s+\w+ed\b' - - '\bmight(?:\s+\w+)*\s+be\s+\w+ed\b' - - '\will(?:\s+\w+)*\s+be\s+\w+ed\b' \ No newline at end of file diff --git a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt index b3f1157c..39a601e6 100644 --- a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt +++ b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt @@ -1,13 +1,30 @@ +# General + Botpress [Bb]ot -Node(s)? +Webchat +LLM(s)? +LLMz(s)? + + +# UI concepts + +Dashboard Studio +Node(s)? Start Node(s)? +End Node(s)? +Entry Node(s)? +Exit Node(s)? +Error Node(s)? Autonomous Node(s)? End Node(s)? -Webchat -LLM(s)? -LLMz(s)? +Trigger(s)? +Card(s)? + + +# Other + Wordpress Wix Webflow \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index c3687434..fc7b82ab 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,4 @@ { - "cSpell.words": ["agentic", "Botpress", "chatbots", "HITL", "Webchat"], "[mdx]": { "editor.wordWrap": "on", "editor.defaultFormatter": "esbenp.prettier-vscode", diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index ef154863..9ba91339 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,20 +4,22 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- +testtest It's easy to build an AI agent on Botpress, regardless of your level of development experience. By the end of this guide, you'll have a bot that will: -* Display a custom greeting -* Use AI to respond to messages -* Follow specific instructions -* Have a unique, shareable link +- Display a custom greeting +- Use AI to respond to messages +- Follow specific instructions +- Have a unique, shareable link This guide is designed to teach a total beginner how to deploy their first bot. If you have more questions and want to get creative with bot-building, check out the [Guides section](/learn/guides/how-to) for detailed how-to guides. For detailed explanations of any of the concepts introduced on this page, check out our [Dashboard](/learn/get-started/dashboard/workspace/introduction) and [Studio](/learn/reference/introduction) guides. + ## Step 1: Build your bot @@ -44,9 +46,9 @@ Each step in a Workflow is represented by a Node. Let's open the **Main** Workfl The **Main** Workflow contains the main logic for your bot — it executes as soon as a user starts a new conversation. By default, the **Main** Workflow contains: -* A `Start Node` -* An `Autonomous Node` -* An `End Node` +- A `Start Node` +- An `Autonomous Node` +- An `End Node` Notice the path connecting the Start Node and the Autonomous Node: @@ -60,6 +62,7 @@ Drag Nodes You can drag a Node to move it anywhere in your Workflow. Just select and hold the Node, then drag and release wherever you want to move it. Moving a Node doesn't affect your bot's behavior — it just helps keep your Workflow organized. + #### Display a custom greeting @@ -145,6 +148,7 @@ Webchat preview displays your bot the way it appears to an actual user, regardle Congratulations! You just built, tested and deployed your first bot with Botpress! + ## Next steps @@ -152,18 +156,10 @@ You just built, tested and deployed your first bot with Botpress! Now that you know the basics of Botpress, you can start getting creative: - + Follow detailed how-to guides - + Learn about the key concepts of Botpress - \ No newline at end of file + From 1b0c5c2d02183c06bd66fbd4b3c0703b5eaaff7c Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Mon, 11 Aug 2025 17:31:57 -0400 Subject: [PATCH 02/15] test --- learn/get-started/quick-start.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 9ba91339..7fb69494 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,7 +4,7 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- -testtest +testtesttest It's easy to build an AI agent on Botpress, regardless of your level of development experience. From a3132156471c8bedd3665b576dc209f3e445c7e9 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 11:04:37 -0400 Subject: [PATCH 03/15] test official action --- .github/workflows/run-vale.yml | 10 ++++++++++ learn/get-started/quick-start.mdx | 6 +++--- 2 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/run-vale.yml diff --git a/.github/workflows/run-vale.yml b/.github/workflows/run-vale.yml new file mode 100644 index 00000000..9434f1b7 --- /dev/null +++ b/.github/workflows/run-vale.yml @@ -0,0 +1,10 @@ +name: reviewdog +on: [pull_request] + +jobs: + vale: + name: runner / vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@v2.1.1 \ No newline at end of file diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 7fb69494..646d0924 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,10 +4,10 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- -testtesttest - It's easy to build an AI agent on Botpress, regardless of your level of development experience. - +misspelledword +agent +This sentence is designed to be in passive voice and raise a suggestion. By the end of this guide, you'll have a bot that will: - Display a custom greeting From 8fbe207d31e2a1ee62213dc01a83084e2694057b Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 11:38:52 -0400 Subject: [PATCH 04/15] test --- .github/workflows/run-vale.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/run-vale.yml b/.github/workflows/run-vale.yml index 9434f1b7..515f04a6 100644 --- a/.github/workflows/run-vale.yml +++ b/.github/workflows/run-vale.yml @@ -7,4 +7,8 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: errata-ai/vale-action@v2.1.1 \ No newline at end of file + - uses: errata-ai/vale-action@v2.1.1 + with: + filter_mode: added + reporter: github-pr-review + token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file From e0a1eb8b0e10473242a4e2c34cc13bd8d5ec7577 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 11:50:19 -0400 Subject: [PATCH 05/15] test add permission --- .github/workflows/run-vale.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/run-vale.yml b/.github/workflows/run-vale.yml index 515f04a6..d003c6a6 100644 --- a/.github/workflows/run-vale.yml +++ b/.github/workflows/run-vale.yml @@ -1,10 +1,16 @@ name: reviewdog on: [pull_request] +permissions: + contents: read + pull-requests: write jobs: vale: name: runner / vale runs-on: ubuntu-latest + permissions: + pull-requests: write + steps: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@v2.1.1 From 95050eae2427ca90bdb0ff1a7b7cf3acc75be483 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 11:55:38 -0400 Subject: [PATCH 06/15] test fail on error --- .github/workflows/run-vale.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/run-vale.yml b/.github/workflows/run-vale.yml index d003c6a6..a40f6d0b 100644 --- a/.github/workflows/run-vale.yml +++ b/.github/workflows/run-vale.yml @@ -10,11 +10,12 @@ jobs: runs-on: ubuntu-latest permissions: pull-requests: write - + steps: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@v2.1.1 with: filter_mode: added reporter: github-pr-review + fail_on_error: true token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file From 3af4e43fac965f29f9232d0151909fad4d7213df Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 11:59:19 -0400 Subject: [PATCH 07/15] clear up errors --- learn/get-started/quick-start.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 646d0924..219e418c 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -5,9 +5,7 @@ icon: rocket --- It's easy to build an AI agent on Botpress, regardless of your level of development experience. -misspelledword -agent -This sentence is designed to be in passive voice and raise a suggestion. + By the end of this guide, you'll have a bot that will: - Display a custom greeting From 66568c652ead02bb555aa8541ca6894f41b7bbd6 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 12:01:00 -0400 Subject: [PATCH 08/15] adds new errors --- learn/get-started/quick-start.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 219e418c..a7bd5cbd 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,6 +4,12 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- +addz a new error + +This doc has been edited. + +agent + It's easy to build an AI agent on Botpress, regardless of your level of development experience. By the end of this guide, you'll have a bot that will: From 84331763ea4ba7bc603c8980c5820f9ecfcaefa6 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 13:03:12 -0400 Subject: [PATCH 09/15] remove test and change workflow def --- .github/workflows/run-vale.yml | 2 -- learn/get-started/quick-start.mdx | 6 ------ 2 files changed, 8 deletions(-) diff --git a/.github/workflows/run-vale.yml b/.github/workflows/run-vale.yml index a40f6d0b..536c9a1f 100644 --- a/.github/workflows/run-vale.yml +++ b/.github/workflows/run-vale.yml @@ -15,7 +15,5 @@ jobs: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@v2.1.1 with: - filter_mode: added - reporter: github-pr-review fail_on_error: true token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index a7bd5cbd..219e418c 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,12 +4,6 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- -addz a new error - -This doc has been edited. - -agent - It's easy to build an AI agent on Botpress, regardless of your level of development experience. By the end of this guide, you'll have a bot that will: From e3bcb22ade923427b234e83665a24d506c51f242 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 13:04:38 -0400 Subject: [PATCH 10/15] add new errors --- learn/get-started/quick-start.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 219e418c..fcff5555 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,6 +4,12 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- +agent + +makeerror + +This doc has been edited. + It's easy to build an AI agent on Botpress, regardless of your level of development experience. By the end of this guide, you'll have a bot that will: From 28b9c6cadb6d1b6f88f0de0c73b1cb7fb959f9aa Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 13:22:13 -0400 Subject: [PATCH 11/15] move job and change mistakes --- .github/workflows/run-checks.yml | 17 ++++++++++++++++- .github/workflows/run-vale.yml | 19 ------------------- learn/get-started/quick-start.mdx | 6 +----- 3 files changed, 17 insertions(+), 25 deletions(-) delete mode 100644 .github/workflows/run-vale.yml diff --git a/.github/workflows/run-checks.yml b/.github/workflows/run-checks.yml index c00c8bb1..7c50a249 100644 --- a/.github/workflows/run-checks.yml +++ b/.github/workflows/run-checks.yml @@ -4,10 +4,12 @@ on: pull_request permissions: id-token: write + pull-requests: write contents: read jobs: - run-checks: + broken-links: + name: Broken Links runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -16,3 +18,16 @@ jobs: version: 8.6.2 - run: pnpm i --frozen-lockfile - run: pnpm run check:links + vale: + name: Writing Checks + runs-on: ubuntu-latest + permissions: + pull-requests: write + + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@v2.1.1 + with: + filter_mode: added + fail_on_error: true + token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/.github/workflows/run-vale.yml b/.github/workflows/run-vale.yml deleted file mode 100644 index 536c9a1f..00000000 --- a/.github/workflows/run-vale.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: reviewdog -on: [pull_request] -permissions: - contents: read - pull-requests: write - -jobs: - vale: - name: runner / vale - runs-on: ubuntu-latest - permissions: - pull-requests: write - - steps: - - uses: actions/checkout@v4 - - uses: errata-ai/vale-action@v2.1.1 - with: - fail_on_error: true - token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index fcff5555..2b7d1df9 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,11 +4,7 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- -agent - -makeerror - -This doc has been edited. +This is a whole new passive sentence that was written by me. It's easy to build an AI agent on Botpress, regardless of your level of development experience. From c0eee6587c2a00bd38ec426d74af08facbfb38f9 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 13:33:03 -0400 Subject: [PATCH 12/15] yet another test --- .github/workflows/run-checks.yml | 4 +++- learn/get-started/quick-start.mdx | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/run-checks.yml b/.github/workflows/run-checks.yml index 7c50a249..e8188f4c 100644 --- a/.github/workflows/run-checks.yml +++ b/.github/workflows/run-checks.yml @@ -29,5 +29,7 @@ jobs: - uses: errata-ai/vale-action@v2.1.1 with: filter_mode: added - fail_on_error: true + reporter: github-pr-review + vale_flags: --minAlertLevel=error + fail_on_error: false token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 2b7d1df9..e543fa7d 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,7 +4,11 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- -This is a whole new passive sentence that was written by me. +This is a sentence with an erore. + +This is a sentence I wrote with a warning. + +A suggestion should be raised by this sentence. It's easy to build an AI agent on Botpress, regardless of your level of development experience. From 93195f2b13119e603c481a20c5cdc55446a5f777 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 15:03:20 -0400 Subject: [PATCH 13/15] finish --- .vale.ini | 7 +++++-- .vale/styles/botpress-docs/branding.yml | 4 ++-- .vale/styles/botpress-docs/chatbot.yml | 2 +- .vale/styles/botpress-docs/end-punctuation.yml | 6 ------ .vale/styles/botpress-docs/spelling.yml | 4 ++++ .vale/styles/botpress-docs/workflows.yml | 6 +++--- .../config/vocabularies/botpress-vocab/accept.txt | 5 +++-- Makefile | 14 ++++++++++++++ learn/get-started/quick-start.mdx | 6 ------ 9 files changed, 32 insertions(+), 22 deletions(-) delete mode 100644 .vale/styles/botpress-docs/end-punctuation.yml create mode 100644 .vale/styles/botpress-docs/spelling.yml create mode 100644 Makefile diff --git a/.vale.ini b/.vale.ini index fea1d611..1b85839d 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,5 +6,8 @@ Vocab = botpress-vocab mdx = md [*.mdx] -BasedOnStyles = Vale, Microsoft, botpress-docs -Markup = true \ No newline at end of file +BasedOnStyles = Microsoft, botpress-docs +Markup = true + +[*] +Microsoft.We = NO \ No newline at end of file diff --git a/.vale/styles/botpress-docs/branding.yml b/.vale/styles/botpress-docs/branding.yml index e25d8b1b..dac15562 100644 --- a/.vale/styles/botpress-docs/branding.yml +++ b/.vale/styles/botpress-docs/branding.yml @@ -1,6 +1,6 @@ extends: existence -message: "Use 'Botpress' for proper branding" -level: warning +message: "Use 'Botpress'" +level: error ignorecase: false vocab: false tokens: diff --git a/.vale/styles/botpress-docs/chatbot.yml b/.vale/styles/botpress-docs/chatbot.yml index c05016ec..4bb67ddd 100644 --- a/.vale/styles/botpress-docs/chatbot.yml +++ b/.vale/styles/botpress-docs/chatbot.yml @@ -1,6 +1,6 @@ extends: substitution message: "Use 'bot' instead of 'chatbot" -level: warning +level: error ignorecase: false vocab: false swap: diff --git a/.vale/styles/botpress-docs/end-punctuation.yml b/.vale/styles/botpress-docs/end-punctuation.yml deleted file mode 100644 index 365e151f..00000000 --- a/.vale/styles/botpress-docs/end-punctuation.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "Sentences require end punctuation" -level: warning -scope: sentence -tokens: - - '[.!?]"?$' \ No newline at end of file diff --git a/.vale/styles/botpress-docs/spelling.yml b/.vale/styles/botpress-docs/spelling.yml new file mode 100644 index 00000000..3d087078 --- /dev/null +++ b/.vale/styles/botpress-docs/spelling.yml @@ -0,0 +1,4 @@ +# Uses the built-in dictionary and filters. +extends: spelling +message: "Did you really mean '%s'?" +level: suggestion \ No newline at end of file diff --git a/.vale/styles/botpress-docs/workflows.yml b/.vale/styles/botpress-docs/workflows.yml index 33c41792..e9f7a1c7 100644 --- a/.vale/styles/botpress-docs/workflows.yml +++ b/.vale/styles/botpress-docs/workflows.yml @@ -1,8 +1,8 @@ extends: substitution -message: "Use '%s' instesad of '%s'" -level: warning +message: "If you're referring to the Botpress concept, use '%s' instesad of '%s'" +level: error action: name: replace ignorecase: false swap: - workflow|flow|Flow: Workflow \ No newline at end of file + workflow|workflows|flow|flows|Flow|Flows: Workflow(s) \ No newline at end of file diff --git a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt index 39a601e6..a42f9268 100644 --- a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt +++ b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt @@ -5,7 +5,7 @@ Botpress Webchat LLM(s)? LLMz(s)? - +agent # UI concepts @@ -21,7 +21,8 @@ Autonomous Node(s)? End Node(s)? Trigger(s)? Card(s)? - +Hook(s)? +Workflow(s)? # Other diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..0214f3bb --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +CHANGED_FILES=$(shell \ + (git diff --name-only master...HEAD; \ + git ls-files --modified --others --exclude-standard) \ + | sort -u | grep -E '\.(md|mdx)$$' || true \ +) + +check-writing: + @echo "🔍 Looking for changed Markdown or MDX files..." + @if [ -n "$(CHANGED_FILES)" ]; then \ + echo "📝 Running Vale on: $(CHANGED_FILES)"; \ + vale $(CHANGED_FILES); \ + else \ + echo "✅ No changed Markdown or MDX files found."; \ + fi \ No newline at end of file diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index e543fa7d..219e418c 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,12 +4,6 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- -This is a sentence with an erore. - -This is a sentence I wrote with a warning. - -A suggestion should be raised by this sentence. - It's easy to build an AI agent on Botpress, regardless of your level of development experience. By the end of this guide, you'll have a bot that will: From 70f554a97544107a4529fc5d7bc4631dfed17b77 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 15:07:58 -0400 Subject: [PATCH 14/15] revert changes --- learn/get-started/quick-start.mdx | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/learn/get-started/quick-start.mdx b/learn/get-started/quick-start.mdx index 219e418c..7d260355 100644 --- a/learn/get-started/quick-start.mdx +++ b/learn/get-started/quick-start.mdx @@ -4,20 +4,20 @@ description: Build, test, and deploy your first AI agent. icon: rocket --- + It's easy to build an AI agent on Botpress, regardless of your level of development experience. By the end of this guide, you'll have a bot that will: -- Display a custom greeting -- Use AI to respond to messages -- Follow specific instructions -- Have a unique, shareable link +* Display a custom greeting +* Use AI to respond to messages +* Follow specific instructions +* Have a unique, shareable link This guide is designed to teach a total beginner how to deploy their first bot. If you have more questions and want to get creative with bot-building, check out the [Guides section](/learn/guides/how-to) for detailed how-to guides. For detailed explanations of any of the concepts introduced on this page, check out our [Dashboard](/learn/get-started/dashboard/workspace/introduction) and [Studio](/learn/reference/introduction) guides. - ## Step 1: Build your bot @@ -44,9 +44,9 @@ Each step in a Workflow is represented by a Node. Let's open the **Main** Workfl The **Main** Workflow contains the main logic for your bot — it executes as soon as a user starts a new conversation. By default, the **Main** Workflow contains: -- A `Start Node` -- An `Autonomous Node` -- An `End Node` +* A `Start Node` +* An `Autonomous Node` +* An `End Node` Notice the path connecting the Start Node and the Autonomous Node: @@ -60,7 +60,6 @@ Drag Nodes You can drag a Node to move it anywhere in your Workflow. Just select and hold the Node, then drag and release wherever you want to move it. Moving a Node doesn't affect your bot's behavior — it just helps keep your Workflow organized. - #### Display a custom greeting @@ -146,7 +145,6 @@ Webchat preview displays your bot the way it appears to an actual user, regardle Congratulations! You just built, tested and deployed your first bot with Botpress! - ## Next steps @@ -154,10 +152,18 @@ You just built, tested and deployed your first bot with Botpress! Now that you know the basics of Botpress, you can start getting creative: - + Follow detailed how-to guides - + Learn about the key concepts of Botpress From 559692130c180d179216350b0fce07675c5a5c6d Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Tue, 12 Aug 2025 15:14:14 -0400 Subject: [PATCH 15/15] remove whitespace