Skip to content

docs: improve rule docs and readme#436

Open
peaklabs-dev wants to merge 2 commits into
driftingly:mainfrom
peaklabs-dev:docs/improve-rules-and-readme
Open

docs: improve rule docs and readme#436
peaklabs-dev wants to merge 2 commits into
driftingly:mainfrom
peaklabs-dev:docs/improve-rules-and-readme

Conversation

@peaklabs-dev
Copy link
Copy Markdown

Changes

  • added Sets to each rule which makes it a lot easier to check if a rule is applied already or needs to be added manually
  • added missing new rule AppToResolveRector
  • improve MinutesToSecondsInCacheRector rule description
  • improve multiple README sections for better understandability
  • rewrote the manual configuration section for easier understanding
  • added some details to sets that are helpful for deciding to add all rules manually or to use sets (some options are only available via sets for example)
  • added missing configurable and opinionated rules to README file
  • sorted opinionated rules alphabetically

- improve multiple sections for better understandability
- rewrote the manual configuration section for easier understanding
- added some details to sets that are helpful to decide to add all rules manually or use sets
- added missing configurable and opinionated rules
- sorted opinionated rules alphabetically
- added Sets to each rule
- added missing rule AppToResolveRector
- improve MinutesToSecondsInCacheRector rule description
@peaklabs-dev peaklabs-dev marked this pull request as ready for review December 2, 2025 18:20
@peterfox peterfox self-assigned this Dec 3, 2025
@peterfox
Copy link
Copy Markdown
Collaborator

I think this was a good idea for the README.md but the rules document is actually autogenerated by the composer docs command. If anything we probably should do the same with sets to update the README.md file or generate a new one just for sets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants