Skip to content
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

Support plugins without rule docs #400

Open
bmish opened this issue Jan 25, 2023 · 0 comments
Open

Support plugins without rule docs #400

bmish opened this issue Jan 25, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@bmish
Copy link
Owner

bmish commented Jan 25, 2023

I have seen a few plugins that put all their rule docs in the top-level README.md:

While such plugins can use --init-rule-docs to create new rule docs, they might prefer to keep all their rule docs in one doc file.

Possible ways we could achieve this:

  • --path-rule-doc = README.md without the {name} placeholder would indicate that the docs are all in a single file
  • --path-rule-doc = undefined to indicate the docs shouldn't be managed
  • Or more explicit options
@bmish bmish added the enhancement New feature or request label Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant