getrector-com icon indicating copy to clipboard operation
getrector-com copied to clipboard

Improve rules configuration docs

Open tigitz opened this issue 6 months ago • 0 comments

Hello,

I've noticed that the current documentation for Rector rules only shows the configuration setup, but it doesn't explain the purpose of the configuration values. This forces me to open the rule directly in my IDE to understand the details.

For example, this page: https://getrector.com/rule-detail/class-property-assign-to-constructor-promotion-rector

It might be useful to automatically parse the relevant information from the Rule file and inject it into the documentation. Could improve DX, especially during project setup.

tigitz avatar Aug 13 '24 13:08 tigitz