Skip to content

add documentation for rules #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

add documentation for rules #394

wants to merge 1 commit into from

Conversation

Wenzhi
Copy link

@Wenzhi Wenzhi commented Sep 9, 2022

I pull the documentation for each rule from the rule files and aggregate them on the Configuration page.

In the original documentation, Lint and Format are documented as separate sections. However, here I'm putting them in the same line in the hope it will make searching for a specific rule easier. Please let me know if you prefer to break it into sub-bullets.

This should solve issue #382 .

@pronebird
Copy link

pronebird commented Mar 23, 2023

@MaxDesiatov do you guys accept 3rd party PRs or is this project just an internal tool and open sourced for marketing purposes?

@allevato
Copy link
Member

allevato commented Sep 8, 2023

Thank you for the effort here! However, we've decided to go with the approach merged in #615, which generates the documentation automatically as part of generate-pipeline.

@allevato allevato closed this Sep 8, 2023
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.

4 participants