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
6 changes: 6 additions & 0 deletions .github/styles/Apify/AdmonitionTitle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: existence
message: "Admonitions must have titles (e.g., ':::note My title')."
level: error
scope: raw
raw:
- ":::(note|tip|info|caution|danger)\\s*\\n"
14 changes: 14 additions & 0 deletions .github/styles/Apify/HeadingGerund.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
extends: existence
message: "Avoid gerunds (-ing) in headings. Use noun phrases or imperatives."
level: warning
scope: heading
tokens:
- '^\w+ing\b'
exceptions:
- Billing
- Pricing
- Debugging
- String
- Caching
- Logging
- Troubleshooting
6 changes: 6 additions & 0 deletions .github/styles/Apify/ImageAltText.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: existence
message: "Images must include meaningful alt text."
level: error
scope: raw
raw:
- '!\[\]\('
9 changes: 8 additions & 1 deletion .github/styles/Apify/Languages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,11 @@ swap:
'(?<!-)python(?!-)': Python
'typescript|Typescript|typescript': TypeScript
'nodejs|Nodejs|node.js': Node.js
# Add more languages or common mistakes as needed
'Github': GitHub
'chatgpt|Chatgpt|chatGPT': ChatGPT
'Mongodb|mongodb': MongoDB
'Postgresql|postgresql|postgres': PostgreSQL
'vscode|VSCode|VS code': VS Code
'Wordpress|wordpress': WordPress
'N8n|N8N': n8n
'Langchain|langchain': LangChain
15 changes: 15 additions & 0 deletions .github/styles/Apify/SalesLanguage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
extends: existence
message: "Avoid sales language. Use factual, specific claims instead."
level: warning
scope: sentence
tokens:
- ultimate
- cutting-edge
- supercharge
- best-in-class
- game-changing
- revolutionary
- world-class
- next-generation
- state-of-the-art
- seamless
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ BlockIgnores = (?s) (<!--.*?-->)|(```.*?```)
# Disabling rules (NO)
Vale.Spelling = NO
write-good.ThereIs = NO
Microsoft.Dashes = NO
Microsoft.Dashes = YES
Microsoft.Avoid = NO
Microsoft.Contractions = NO
Microsoft.Foreign = NO
Expand Down