docs: Add development workflow docs for the library#67
Merged
philipaconrad merged 1 commit intomainfrom Jan 7, 2026
Merged
Conversation
charlieegan3
reviewed
Jan 5, 2026
docs/internals.md
Outdated
|
|
||
| The process can coarsely be split between OPA and C# sides, but in practice, there's going to be some co-design where a dev might want a certain field in the model to map to a certain name in the Rego policy, and vice versa. Below is the rough process most users will probably find useful for spinning up a C# application that uses this library. | ||
|
|
||
| Generally, the flow for a data filter is: Rego -> UCAST -> C# -> LINQ Query -> SQL Query -> Database |
Member
Author
There was a problem hiding this comment.
I had that thought too over the weekend. I'll see what I can whip up!
Member
Author
There was a problem hiding this comment.
Moved the intro and sequence diagram to the project README, because I think they will be much more useful over there. I retargeted this document to focus on the development workflow, and I think it's better for not trying to do more things at once.
charlieegan3
reviewed
Jan 5, 2026
charlieegan3
reviewed
Jan 5, 2026
charlieegan3
reviewed
Jan 5, 2026
charlieegan3
reviewed
Jan 5, 2026
charlieegan3
reviewed
Jan 5, 2026
philipaconrad
force-pushed
the
philip/docs-improvements
branch
2 times, most recently
from
c8239f7 to
9d24fcf
Compare
Signed-off-by: Philip Conrad <philip@chariot-chaser.net>
philipaconrad
force-pushed
the
philip/docs-improvements
branch
from
9d24fcf to
abcd48a
Compare
philipaconrad
changed the title
charlieegan3
approved these changes
Jan 7, 2026
charlieegan3
left a comment
charlieegan3
left a comment
There was a problem hiding this comment.
LGTM, I like the new diagram a lot
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔩 What code changed, and why?
This PR is a first stab at getting some proper "big picture" documentation around how this library goes from Rego policies to LINQ
Expressiontrees.It started as a bit of a meandering guide, because I was aiming to capture as much of the ugly stuff as I could remember about the development workflow and internals. Thanks @charlieegan3 for the initial rough editing pass.
I've chosen to focus on the development workflow in this docs PR, and will aim to get down into the nitty-gritty of the internals, with LINQ operators and Expression trees and whatnot, in future docs work.
Future work
MappingConfiguration<T>examples, illustrating all the stuff that's possible.