From 3fe7cfebd0978bcbaaaae8cc03a20b6e00e9c15e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Sun, 17 Aug 2025 12:28:24 +0200 Subject: [PATCH 1/3] docs: enhace Vale rules --- .github/styles/Apify/Apify.yml | 5 +++++ .github/styles/Apify/Capitalization.yml | 24 +++++++++++------------- .github/styles/Apify/Languages.yml | 19 +++++++++++++++---- 3 files changed, 31 insertions(+), 17 deletions(-) diff --git a/.github/styles/Apify/Apify.yml b/.github/styles/Apify/Apify.yml index ff61ff6ca2..34d1ae2b18 100644 --- a/.github/styles/Apify/Apify.yml +++ b/.github/styles/Apify/Apify.yml @@ -3,8 +3,13 @@ message: "Use '%s' instead of '%s'." ignorecase: false level: warning swap: + # Brand consistency Apify Dashboard: Apify Console apify freelancers: Apify freelancers Apify Platform: Apify platform + + # Product names '(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy + + # Writing style circa: approx. diff --git a/.github/styles/Apify/Capitalization.yml b/.github/styles/Apify/Capitalization.yml index 88587e6a98..e562a0125a 100644 --- a/.github/styles/Apify/Capitalization.yml +++ b/.github/styles/Apify/Capitalization.yml @@ -1,20 +1,18 @@ extends: existence -message: "The word '%s' should always be capitalized." +message: "The word '%s' should always be capitalized when referring to Apify products." ignorecase: false level: error +scope: text tokens: - # Before the word there should be no: /, -, #, word character - # (avoids anchors, URLs, identifiers, and words like 'factors') - # - # After the word there should be no: /, } (avoids paths or URLs) - # Also no . followed by a word character (avoids 'actors.md') + # Apify Actors (the product) - avoid matching in URLs, code, or other contexts - '(? Date: Sun, 17 Aug 2025 12:11:06 +0200 Subject: [PATCH 2/3] improve accept.txt organization --- .../config/vocabularies/Docs/accept.txt | 111 +++++++++--------- 1 file changed, 57 insertions(+), 54 deletions(-) diff --git a/.github/styles/config/vocabularies/Docs/accept.txt b/.github/styles/config/vocabularies/Docs/accept.txt index 589b45daae..09e135a26f 100644 --- a/.github/styles/config/vocabularies/Docs/accept.txt +++ b/.github/styles/config/vocabularies/Docs/accept.txt @@ -1,11 +1,17 @@ +# Apify-specific terms and products \bApify\b(?:-\w+)? @apify\.com -SDK(s) -[Ss]torages Crawlee [Aa]utoscaling CU +# Technical terms and abbreviations +SDK(s)? +API's? +APIs +webhook's? +idempotency +backoff booleans env npm @@ -15,36 +21,43 @@ node_modules [Rr]egex [Mm]onorepo [Gg]ist -SDK Dockerfile Docker's - Docusaurus navbar nginx -npm camelCase - -:::caution -:::note -:::info -:::tip -:::warning - maxWidth startUrls - PDFs -dataset's +dataset's? gif Gzip +hostname +IPs +unscoped +multistep +[Aa]utogenerated +preconfigured +[Dd]atacenter +asyncio +backlinks? +captchas? +combinator +deduplicating +parallelization +READMEs +reindexes +screenshotting +SKUs? +subreddits? +upvote +walkthroughs? -API's -APIs -webhook's -idempotency -backoff +# Storage and data terms +[Ss]torages +# Authentication and security Authy reCaptcha OAuth @@ -52,11 +65,11 @@ untrusted unencrypted proxied +# AI LLM embedder chatbot [Ll]angchain - [Kk]eboola [Aa]irbyte [Qq]drant @@ -65,61 +78,51 @@ chatbot [Zz]illiz llama_index [Ff]lowise +Langflow +[Aa]gno +[Gg]umloop +# Technical concepts exploitability [Ww]hitepaper [Cc]ron scalably metamorph -hostname -IPs -unscoped -multistep -[Aa]utogenerated -preconfigured -[Dd]atacenter +# Third-party services and platforms [Ww]ikipedia [Zz]apier [Tt]rello [Pp]refill -[Gg]umloop - [Mm]ultiselect - -devs -asyncio -backlinks? -captchas? -Chatbot -combinator -deduplicating -dev Fakestore Fandom('s)? IMDb -influencers iPads? iPhones? jQuery -Langflow -learnings -livestreams -outro -parallelization -READMEs -reindexes -[Rr]epurpose -screenshotting -[Ss]crapy Shein('s)? Shopify -SKUs? -subreddits? [Ss]ubwoofer Tripadvisor -upvote -walkthroughs? +[Ss]crapy + +# Content and media +influencers +learnings +livestreams +outro +[Rr]epurpose +# Development and tools +devs +dev ul -[Aa]gno +pnpm + +# Docusaurus admonitions +:::caution +:::note +:::info +:::tip +:::warning From 2a3c816d668a2bf6528c9a810fafd85ca6140018 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Sun, 17 Aug 2025 12:32:21 +0200 Subject: [PATCH 3/3] further revisions --- .github/styles/Apify/Apify.yml | 2 +- .github/styles/Apify/Capitalization.yml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/styles/Apify/Apify.yml b/.github/styles/Apify/Apify.yml index 34d1ae2b18..596f869676 100644 --- a/.github/styles/Apify/Apify.yml +++ b/.github/styles/Apify/Apify.yml @@ -3,7 +3,7 @@ message: "Use '%s' instead of '%s'." ignorecase: false level: warning swap: - # Brand consistency + # Naming consistency Apify Dashboard: Apify Console apify freelancers: Apify freelancers Apify Platform: Apify platform diff --git a/.github/styles/Apify/Capitalization.yml b/.github/styles/Apify/Capitalization.yml index e562a0125a..f7af29a78d 100644 --- a/.github/styles/Apify/Capitalization.yml +++ b/.github/styles/Apify/Capitalization.yml @@ -4,15 +4,15 @@ ignorecase: false level: error scope: text tokens: - # Apify Actors (the product) - avoid matching in URLs, code, or other contexts + # Apify Actors - avoid matching in URLs, code, or other contexts - '(?