From e80b02b2b95907f57602476bbaad80b87dedc0b7 Mon Sep 17 00:00:00 2001 From: Charlie Egan <charlie@styra.com> Date: Thu, 19 Dec 2024 09:53:15 +0000 Subject: [PATCH] Update Regal documentation Corrected the broken configuration link, and made a few small edits to the copy. --- docs/tools/regal.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/tools/regal.md b/docs/tools/regal.md index 0783ebdd..d05be084 100644 --- a/docs/tools/regal.md +++ b/docs/tools/regal.md @@ -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 @@ -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)