Add guidance for variable analysis mode#335
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThis PR updates BloodHound Enterprise documentation across three MDX files to explain Variable Analysis Mode. Changes include a new "Analysis stages" section, a "Variable Analysis Mode" section, a repositioned remediation link, a Privilege Zone rule validation callout, an updated analysis-completion note, and a tenant status callout. ChangesVariable Analysis Mode Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/analyze-data/findings/analysis.mdx`:
- Around line 52-61: The Variable Analysis Mode description uses inconsistent
terminology by saying it skips the “pre-processing stages,” while the analysis
docs and stage naming in this section use “post-processing” terminology. Update
the wording in the Variable Analysis Mode paragraph to match the existing
analysis stage terms used elsewhere in analysis.mdx, keeping the rest of the
explanation intact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b0f161c4-7883-4718-a54c-4a90150ce957
📒 Files selected for processing (3)
docs/analyze-data/findings/analysis.mdxdocs/analyze-data/privilege-zones/overview.mdxdocs/collect-data/enterprise-collection/monitor.mdx
|
|
||
| BloodHound Enterprise's analysis process includes several key steps that work together to surface findings and prioritize risk. | ||
|
|
||
| ## Analysis stages |
There was a problem hiding this comment.
This feels necessary to contextualize variable analysis mode, but I'm open to alternatives. I'm not sure if this accurately represents reality. If it's possible to separate analysis into stages like this, we'll also need a little more info about "tagging" and what differentiates it from other stages.
There was a problem hiding this comment.
As long as we note to ourselves that line 22 needs to be modified once variable analysis GAs, that's fine.
There was a problem hiding this comment.
Noted. We're in a similar situation with OpenGraph Management at the moment.
StephenHinck
left a comment
There was a problem hiding this comment.
I'm fine with this so long as you track ripping it all out later. I'm not sure how much depth you want to give EA flags across docs for things that will only live in EA for a short period as it could become a lot of churn and things to track.
|
|
||
| BloodHound Enterprise's analysis process includes several key steps that work together to surface findings and prioritize risk. | ||
|
|
||
| ## Analysis stages |
There was a problem hiding this comment.
As long as we note to ourselves that line 22 needs to be modified once variable analysis GAs, that's fine.
|
|
||
| <PostProcessedEdges /> | ||
|
|
||
| ## Variable Analysis Mode |
There was a problem hiding this comment.
Same thing here - this would need to be completely ripped out after GA, as it will just be "how the product works"
Summary by CodeRabbit
Staging
https://specterops-variable-analysis-mode-clean.mintlify.site/analyze-data/findings/analysis