Update Regal documentation

[charlieegan3]

Corrected the broken configuration link, and made a few small edits to the copy.

[coderabbitai]

Walkthrough

The documentation for Regal, the language server for Rego (Open Policy Agent's language), has been updated to provide more precise and consistent information. The changes focus on clarifying the tool's description, specifying the exact configuration file location, and standardizing terminology related to configuration settings.

Changes

File	Change Summary
docs/tools/regal.md	- Clarified Regal's description as a language server for Rego - Specified configuration file location as .regal/config.yaml - Standardized terminology around configuration file references

Poem

🐰 In the realm of Regal's might,
Docs now shine with clarity bright
Config paths precise and clear
Rego's language server, drawing near
A rabbit's guide, both sharp and light! 🔍

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e88daf and e80b02b.

📒 Files selected for processing (1)

• docs/tools/regal.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/tools/regal.md

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd5c45a and 3e88daf.

📒 Files selected for processing (1)

• docs/tools/regal.md (2 hunks)

🔇 Additional comments (1)

docs/tools/regal.md (1)

13-13: LGTM! Clear and informative description.

The updated description provides better context by explicitly mentioning Rego's relationship with OPA and including appropriate links.

[alexcoderabbitai]

@coderabbitai fix this

Run actions/checkout@v4
  with:
    ref: patch-1
    repository: coderabbitai/coderabbit-docs
    token: ***
    ssh-strict: true
    ssh-user: git
    persist-credentials: true
    clean: true
    sparse-checkout-cone-mode: true
    fetch-depth: 1
    fetch-tags: false
    show-progress: true
    lfs: false
    submodules: false
    set-safe-directory: true
Syncing repository: coderabbitai/coderabbit-docs
Getting Git version info
  Working directory is '/home/runner/work/coderabbit-docs/coderabbit-docs'
  /usr/bin/git version
  git version [2](https://github.com/coderabbitai/coderabbit-docs/pull/181/checks#step:2:2).47.1
Temporarily overriding HOME='/home/runner/work/_temp/75e9[3](https://github.com/coderabbitai/coderabbit-docs/pull/181/checks#step:2:3)237-5813-4471-bee9-5c02d5983b[4](https://github.com/coderabbitai/coderabbit-docs/pull/181/checks#step:2:4)7' before making global git config changes
Adding repository directory to the temporary git global config as a safe directory
/usr/bin/git config --global --add safe.directory /home/runner/work/coderabbit-docs/coderabbit-docs
Deleting the contents of '/home/runner/work/coderabbit-docs/coderabbit-docs'
Initializing the repository
Disabling automatic garbage collection
Setting up auth
Fetching the repository
  /usr/bin/git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin +refs/heads/patch-1*:refs/remotes/origin/patch-1* +refs/tags/patch-1*:refs/tags/patch-1*
  The process '/usr/bin/git' failed with exit code 1
  Waiting 1[9](https://github.com/coderabbitai/coderabbit-docs/pull/181/checks#step:2:9) seconds before trying again
  /usr/bin/git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin +refs/heads/patch-1*:refs/remotes/origin/patch-1* +refs/tags/patch-1*:refs/tags/patch-1*
  The process '/usr/bin/git' failed with exit code 1
  Waiting [11](https://github.com/coderabbitai/coderabbit-docs/pull/181/checks#step:2:11) seconds before trying again
  /usr/bin/git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin +refs/heads/patch-1*:refs/remotes/origin/patch-1* +refs/tags/patch-1*:refs/tags/patch-1*
  Error: The process '/usr/bin/git' failed with exit code 1

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@alexcoderabbitai: It looks like the checkout step is failing because Git can’t fetch the patch-1 branch. Here are a few troubleshooting steps:

1. Confirm the branch exists
   Make sure patch-1 actually exists in the coderabbitai/coderabbit-docs repository. Sometimes this can happen if the branch is on a fork and Actions is expecting it in the main repo.

2. Remove wildcard references
   Instead of +refs/heads/patch-1*:refs/remotes/origin/patch-1*, try simply:

   with:
     ref: patch-1

   That way, you’ll directly check out the existing branch.

3. Check token permissions
   If this is a private repo or restricted branch, ensure the Action’s GITHUB_TOKEN has “Read repository” permission enabled for PR branches.

Let me know if this helps resolve the issue.