docs: regal

[cr-ruhanmuzaffar]

Summary by CodeRabbit

• New Features

  • Introduced comprehensive documentation for the Regal linter and language server, enhancing user understanding of .rego file handling.
  • Added a reference to Regal in the tools section for easy access to its documentation.

• Documentation

  • Updated the tools documentation to include information about Regal and ensured proper formatting.

[coderabbitaidev]

Walkthrough

The documentation has been enhanced with the introduction of Regal, a linter and language server for Rego files. This includes a dedicated guide detailing its configuration and usage, as well as an entry in the tools section linking to its documentation. The changes improve clarity and accessibility for users working with Regal, ensuring they have the necessary information to configure and utilize the tool effectively.

Changes

Files	Change Summary
docs/tools/regal.md	Introduced a new documentation guide for Regal, detailing configuration and usage.
docs/tools/tools.md	Added an entry for Regal in the tools section, linking to its documentation; ensured proper formatting with a newline.

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	5b13bb5
Status:	✅  Deploy successful!
Preview URL:	https://d7d1ae52.coderabbit-docs.pages.dev
Branch Preview URL:	https://ruhan-regal.coderabbit-docs.pages.dev

View logs

[coderabbitaidev]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 35d2a45 and 5b13bb5.

Files selected for processing (2)

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

Files skipped from review due to trivial changes (1)

• docs/tools/regal.md

Additional context used

Markdownlint

docs/tools/tools.md

84-84: null
Files should end with a single newline character

(MD047, single-trailing-newline)

Additional comments not posted (2)

docs/tools/tools.md (2)

58-58: Addition of Regal to the tools list looks good.

The new entry for Regal is correctly formatted and consistent with other entries in the table.

---

84-84: Addition of Regal link reference is correct.

The link reference for Regal is correctly formatted and points to the appropriate documentation file.

Tools

Markdownlint

84-84: null
Files should end with a single newline character

(MD047, single-trailing-newline)