Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/styles/Apify/Apify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@ message: "Use '%s' instead of '%s'."
ignorecase: false
level: warning
swap:
# Naming 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.
24 changes: 11 additions & 13 deletions .github/styles/Apify/Capitalization.yml
Original file line number Diff line number Diff line change
@@ -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 - avoid matching in URLs, code, or other contexts
- '(?<![\/\-#\w])actors(?![\/\}])(?!\.\w)'

# Before the word there should be no: /, -, #, ., `, word character
# (avoids anchors, URLs, identifiers, code, and words like 'factors')
#
# After the word there should be no: /, }, -, word character (avoids paths or URLs)
# Also no " =" (avoids code like "actor = ...")
# Also no . followed by a word character (avoids 'actor.md' or 'actor.update()')

# Apify Actor - avoid matching in URLs, code, or other contexts
- '(?<![\/\-#\.`\w])actor(?![\/\}\-\w])(?! =)(?!\.\w)'

# Apify Console
- '(?<![\/\-#\.`\w])console(?![\/\}\-\w])(?! =)(?!\.\w)'

# Apify Proxy
- '(?<![\/\-#\.`\w])proxy(?![\/\}\-\w])(?! =)(?!\.\w)'
nonword: false
19 changes: 15 additions & 4 deletions .github/styles/Apify/Languages.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
extends: substitution
message: "Use '%s' instead of '%s'."
message: "Use '%s' instead of '%s' for proper language naming."
ignorecase: false
level: warning
swap:
# JavaScript variations
'javascript|Javascript|javaScript': JavaScript

# Python variations (avoid matching in URLs like python.org)
'(?<!-)python(?!-)': Python
'typescript|Typescript|typescript': TypeScript
'nodejs|Nodejs|node.js': Node.js
# Add more languages or common mistakes as needed

# TypeScript variations
'typescript|Typescript': TypeScript

# Node.js variations
'nodejs|Nodejs|node\.js': Node.js

# Additional common language variations
'js|JS': JavaScript
'ts|TS': TypeScript
'py|PY': Python
111 changes: 57 additions & 54 deletions .github/styles/config/vocabularies/Docs/accept.txt
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -15,48 +21,55 @@ 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
untrusted
unencrypted
proxied

# AI
LLM
embedder
chatbot
[Ll]angchain

[Kk]eboola
[Aa]irbyte
[Qq]drant
Expand All @@ -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