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

Configuration section in rules doc improvements #533

Open
anderseknert opened this issue Jan 18, 2024 · 0 comments
Open

Configuration section in rules doc improvements #533

anderseknert opened this issue Jan 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@anderseknert
Copy link
Member

Screenshot 2024-01-18 at 14 17 08

A new user browsing to the docs for a rule will not know where to put this configuration (.regal/config.yaml). So it would be good if we had the docs for each rule updated to include that above the YAML snippet.

Additionally, we should make configuration options a link pointing to https://docs.styra.com/regal#configuration

@anderseknert anderseknert added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: Planned
Development

No branches or pull requests

1 participant