diff --git a/.github/styles/Apify/AdmonitionTitle.yml b/.github/styles/Apify/AdmonitionTitle.yml new file mode 100644 index 0000000000..3fb4503df1 --- /dev/null +++ b/.github/styles/Apify/AdmonitionTitle.yml @@ -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" diff --git a/.github/styles/Apify/HeadingGerund.yml b/.github/styles/Apify/HeadingGerund.yml new file mode 100644 index 0000000000..8e66b7e769 --- /dev/null +++ b/.github/styles/Apify/HeadingGerund.yml @@ -0,0 +1,28 @@ +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 + - Missing + - Polling + - Timing + - Marketing + - Existing + - Pending + - Underlying + - Remaining + - Corresponding + - Incoming + - Outgoing + - Resulting + - Leading + - Following diff --git a/.github/styles/Apify/ImageAltText.yml b/.github/styles/Apify/ImageAltText.yml new file mode 100644 index 0000000000..634885274f --- /dev/null +++ b/.github/styles/Apify/ImageAltText.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Images must include meaningful alt text." +level: error +scope: raw +raw: + - '!\[\]\(' diff --git a/.github/styles/Apify/Languages.yml b/.github/styles/Apify/Languages.yml index 518584b2fa..d0d4bf5dc6 100644 --- a/.github/styles/Apify/Languages.yml +++ b/.github/styles/Apify/Languages.yml @@ -7,4 +7,11 @@ swap: '(?)|(```.*?```) # 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