Skip to content

docs: improve README and RULES_DESCRIPTIONS#1698

Open
alexandear wants to merge 6 commits intomgechev:masterfrom
alexandear:docs/remove-rules-table-readme
Open

docs: improve README and RULES_DESCRIPTIONS#1698
alexandear wants to merge 6 commits intomgechev:masterfrom
alexandear:docs/remove-rules-table-readme

Conversation

@alexandear
Copy link
Copy Markdown
Collaborator

@alexandear alexandear commented Mar 25, 2026

Improve the description, configuration, and version note for a lot of rules.

Add info about problems with "Typed" rules.

@alexandear alexandear force-pushed the docs/remove-rules-table-readme branch from 69a4609 to 287a760 Compare March 25, 2026 16:31

This comment was marked as outdated.

alexandear and others added 2 commits March 25, 2026 09:33
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

This comment was marked as outdated.

@chavacava
Copy link
Copy Markdown
Collaborator

chavacava commented Mar 26, 2026

IMO the table has its interest because it provides a synthetic view of available rules in the landing page of the project; no need go to the rules description file.

@alexandear alexandear changed the title docs: remove rules table from README docs: improve README and RULES_DESCRIPTIONS Mar 26, 2026
@alexandear alexandear requested a review from Copilot March 26, 2026 11:22
@alexandear
Copy link
Copy Markdown
Collaborator Author

IMO the table has its interest because it provides a synthetic view of available rules in the landing page of the project; no need go to the rules description file.

Thanks for the feedback. I returned the table.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants