Skip to content

Commit

Permalink
Update Regal documentation (#181)
Browse files Browse the repository at this point in the history
Corrected the broken configuration link, and made a few small edits to the copy.

Co-authored-by: Gur singh <[email protected]>
  • Loading branch information
charlieegan3 and guritfaq authored Jan 10, 2025
1 parent a247c97 commit 0528f75
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/tools/regal.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.
[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego, the language of [Open Policy Agent](http://openpolicyagent.org) (OPA).

## Files

Expand All @@ -20,12 +20,10 @@ Regal will run on files with the following extensions:

## Configuration

Regal uses a YAML style configuration file. We look for the following config file:
Regal uses a YAML configuration file located at `.regal/config.yaml`.

- `.regal/config.yaml`

CodeRabbit will use the default settings based on the profile selected if no config file is found.
CodeRabbit will use the default settings based on the profile selected if no configuration file is found.

## Links

- [Regal Configuration](https://docs.styra.com/regal#configuration/)
- [Regal Configuration](https://docs.styra.com/regal#configuration)

0 comments on commit 0528f75

Please sign in to comment.