[docs] Deprecate MD list and use find-rule page instead

rectorphp · Aug 12, 2024 · 8c34543 · 8c34543
1 parent c053b97
commit 8c34543
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/.github/workflows/code_analysis.yaml b/.github/workflows/code_analysis.yaml
@@ -19,6 +19,9 @@ jobs:
                     -
                         name: 'Active Classes'
                         run: vendor/bin/class-leak check config src rules
+                    -
+                        name: "Validate docs"
+                        run: vendor/bin/rule-doc-generator validate src rules
 
         name: ${{ matrix.actions.name }}
         runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Rector Rules for PHP Downgrade
 
-See available [Downgrade rules](/docs/rector_rules_overview.md)
+See available [Downgrade rules](https://getrector.com/find-rule?query=downgrade+rules)
 
 ## Install
 

diff --git a/composer.json b/composer.json
@@ -35,10 +35,7 @@
     "scripts": {
         "phpstan": "vendor/bin/phpstan analyse --ansi --error-format symplify",
         "check-cs": "vendor/bin/ecs check --ansi",
-        "fix-cs": "vendor/bin/ecs check --fix --ansi",
-        "docs": [
-            "vendor/bin/rule-doc-generator generate rules --output-file docs/rector_rules_overview.md --ansi"
-        ]
+        "fix-cs": "vendor/bin/ecs check --fix --ansi"
     },
     "extra": {
         "enable-patching": true

diff --git a/docs/rector_rules_overview.md b/docs/rector_rules_overview.md
@@ -1,5 +1,11 @@
 # 74 Rules Overview
 
+**This overview is deprecated and replaced by more advanced web search. There you can search and filter by nodes, copy-paste configs for configurable rules and more.**
+
+Use https://getrector.com/find-rule?query=downgrade+rules instead!
+
+---
+
 ## ArrowFunctionToAnonymousFunctionRector
 
 Replace arrow functions with anonymous functions