Docs: Document fixing issues, project roots, and new features #1043
Conversation
README.md
Outdated
| using the JSON representation of the Rego abstract syntax tree (AST) as input, a | ||
| few additional custom built-in functions and some indexed data structures to help | ||
| with linting. | ||
| - Deliver an outstanding policy development experience by providing the best possible tools for that purpose |
There was a problem hiding this comment.
Move to the top of Goals, perhaps? Nobody reads the last goal :P
README.md
Outdated
| [OPA VS Code extension](https://marketplace.visualstudio.com/items?itemName=tsandall.opa) | ||
| - Get started with Regal for Zed by installing the [zed-rego](https://github.com/StyraInc/zed-rego) extension | ||
| - Get started with Regal in Neovim using any of the available | ||
| [Regal plug-ins](https://docs.styra.com/regal/editor-support#neovim) |
There was a problem hiding this comment.
main has a section on Helix. Worth adding?
There was a problem hiding this comment.
I think it's good to list all the editors here, but I'd list them on one line, rather than one each. This way it doesn't take up so much space, but people can still scan for their editor.
docs/fixing.md
Outdated
| regal fix <path> [path [...]] [flags] | ||
| ``` | ||
| :::tip | ||
| Before you make any automated fixes, make sure to commit any other changes you may have done in your project! That way |
There was a problem hiding this comment.
| Before you make any automated fixes, make sure to commit any other changes you may have done in your project! That way | |
| Before you make any automated fixes, make sure to commit or stash any other changes you may have done in your project! That way |
| Regal is a linter and language server for [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/), helping | ||
| you write better policies and have fun while doing it! | ||
| Regal is a linter and language server for [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/), making | ||
| your Rego magnificent, and you the ruler of rules! |
There was a problem hiding this comment.
I think it went well with the "regal" theme 👑 😄
README.md
Outdated
| [OPA VS Code extension](https://marketplace.visualstudio.com/items?itemName=tsandall.opa) | ||
| - Get started with Regal for Zed by installing the [zed-rego](https://github.com/StyraInc/zed-rego) extension | ||
| - Get started with Regal in Neovim using any of the available | ||
| [Regal plug-ins](https://docs.styra.com/regal/editor-support#neovim) |
There was a problem hiding this comment.
I think it's good to list all the editors here, but I'd list them on one line, rather than one each. This way it doesn't take up so much space, but people can still scan for their editor.
README.md
Outdated
| By default, the answer to that question would be the **project**, or **workspace** root. But if the file was found | ||
| in a subdirectory containing a **bundle**, the directory naturally belongs under that *bundle's root* instead. The | ||
| `roots` configuration option under the top-level `project` object allows you to tell Regal where these roots are, | ||
| and have features that depend on this information work as expected. |
There was a problem hiding this comment.
Worth calling out which features these are?
|
|
||
| The configuration file is not the only way Regal may determine project roots. Other ways include: | ||
|
|
||
| - A directory containing a `.manifest` file will automatically be registered as a root |
There was a problem hiding this comment.
This feels like it belongs int the By Default sentence above, or at least a reference to. I'd suggest this first over the manual config - or is that no longer preferred?
There was a problem hiding this comment.
Changing "By default" to "Normally", as I don't think using .manifest files is a norm.. even though we should help encourage that.
Honestly, I've not made up my mind yet on whether explicit config for roots or .manifest files is my preferene. I have also been pondering whether explicit configuration should override anything else. I think that perhaps it should... as if you explicitly tell us "use bundle1 as root", maybe we shouldn't go and "use bundle1 and bundle3" as roots 🤔
But I don't feel like this would be terrible to change later, so I'm good with what we got.
charlieegan3
force-pushed
the
dir-pkg-docs
branch
from
ed7c6de to
2969350
Compare
This is a follow-up PR to #1035, documenting the new capabilities of Regal added there Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert
force-pushed
the
dir-pkg-docs
branch
from
2969350 to
64fc399
Compare
…nc#1043) This is a follow-up PR to StyraInc#1035, documenting the new capabilities of Regal added there Signed-off-by: Anders Eknert <anders@styra.com>
This is a follow-up PR to #1035, documenting the new capabilities of Regal added there