Draft
Conversation
Contributor
|
Important Review skippedDraft detected. 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:
WalkthroughThe PR reorganizes BloodHound Enterprise documentation by restructuring attack path and risk acceptance content into a new Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
docs/docs.json (1)
1512-1514: Prefer a direct redirect to avoid chaining legacy posture routes.This mapping currently creates an extra hop (
/analyze-data/bloodhound-gui/posture-page→/analyze-data/posture-page→/analyze-data/findings/posture).🚦 Proposed refinement
{ "source": "/analyze-data/bloodhound-gui/posture-page", - "destination": "/analyze-data/posture-page" + "destination": "/analyze-data/findings/posture" },🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs.json` around lines 1512 - 1514, Update the redirect mapping that currently maps "source": "/analyze-data/bloodhound-gui/posture-page" to "destination": "/analyze-data/posture-page" so it points directly to the final route; change the destination to "/analyze-data/findings/posture" to remove the intermediate hop and avoid chained redirects.docs/analyze-data/findings/posture.mdx (1)
34-37: Consider removing duplicate time picker reference.Lines 34 and 37 both mention that custom date ranges include a time picker. The repetition within the same section may be unnecessary.
♻️ Proposed fix to reduce duplication
Choose from preset ranges or set a custom range to compare specific analysis runs. Custom date ranges include a time picker, so you can set exact start and end times. <Tip> - For meaningful trend comparisons, use the same filter scope and similar date ranges across reviews. Custom date ranges include a time picker, so you can set exact start and end times. + For meaningful trend comparisons, use the same filter scope and similar date ranges across reviews. </Tip>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/analyze-data/findings/posture.mdx` around lines 34 - 37, Remove the duplicated sentence about the time picker by keeping it once and deleting the other occurrence; specifically, in the section that currently contains both the inline sentence "Custom date ranges include a time picker, so you can set exact start and end times." and the identical sentence inside the <Tip> block, retain the tip's phrasing (or the inline line) and remove the redundant copy so the guidance appears only once in the "Choose from preset ranges..." paragraph/Tip pair.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/analyze-data/findings/attack-paths.mdx`:
- Line 12: The sentence "These risks are represented as findings, which includes
prioritization data..." has a subject-verb agreement error; change the verb
"includes" to "include" so the clause reads "which include prioritization
data..." to match the plural subject "findings" (edit the findings sentence in
attack-paths.mdx).
- Line 20: Remove the internal drafting note "**DELETE ME**: Would like to use
some kind of visual..." from the attack-paths.mdx content (the visible callout
at line containing "**DELETE ME**"); replace it with a neutral, user-facing
callout requesting a non-sensitive visual or abstract illustration (e.g.,
"Consider adding an abstract visual or diagram to illustrate attack paths
without revealing sensitive findings") so the page contains no internal
editorial markers and still prompts for safe visuals.
In `@docs/analyze-data/findings/risk-acceptance.mdx`:
- Line 10: Fix two copy issues in the text: replace "for certain amount of time"
with "a certain amount of time" in the sentence that begins "Not every finding
requires immediate remediation..." and capitalize "Enterprise" where it appears
lowercase on the later line (the occurrence currently written as "enterprise")
so it reads "Enterprise"; update both string literals accordingly.
In `@docs/docs.json`:
- Around line 1612-1614: The redirect entry with "source":
"/analyze-data/accept-findings" has an incorrect "destination" value
"/analyze-data/findings/accept"; update the destination to
"/analyze-data/findings/risk-acceptance" so it points to the existing docs page
(docs/analyze-data/findings/risk-acceptance.mdx), keeping the same "source" key
and JSON structure.
In `@docs/resources/glossary/overview.mdx`:
- Around line 102-105: Remove the duplicated sentence in the "Hygiene"
definition: delete the repeated sentence "Examples include dangerous edges
originating from broadly populated default groups. Hygiene findings are
displayed separately in a dedicated filter view on the **Attack Path** and
**Posture** pages." so the Hygiene entry contains that explanation only once,
keeping the single correct instance under the "Hygiene" heading.
---
Nitpick comments:
In `@docs/analyze-data/findings/posture.mdx`:
- Around line 34-37: Remove the duplicated sentence about the time picker by
keeping it once and deleting the other occurrence; specifically, in the section
that currently contains both the inline sentence "Custom date ranges include a
time picker, so you can set exact start and end times." and the identical
sentence inside the <Tip> block, retain the tip's phrasing (or the inline line)
and remove the redundant copy so the guidance appears only once in the "Choose
from preset ranges..." paragraph/Tip pair.
In `@docs/docs.json`:
- Around line 1512-1514: Update the redirect mapping that currently maps
"source": "/analyze-data/bloodhound-gui/posture-page" to "destination":
"/analyze-data/posture-page" so it points directly to the final route; change
the destination to "/analyze-data/findings/posture" to remove the intermediate
hop and avoid chained redirects.
🪄 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: f901d0b7-e025-4589-afbf-e38f51bec0a7
📒 Files selected for processing (13)
docs/analyze-data/accept-findings.mdxdocs/analyze-data/findings/attack-paths.mdxdocs/analyze-data/findings/posture.mdxdocs/analyze-data/findings/risk-acceptance.mdxdocs/analyze-data/overview.mdxdocs/analyze-data/posture-page.mdxdocs/analyze-data/privilege-zones/overview.mdxdocs/docs.jsondocs/integrations/splunk/siem/use.mdxdocs/opengraph/developer/schema.mdxdocs/resources/glossary/overview.mdxdocs/resources/release-notes/2026-01-22.mdxdocs/snippets/analysis/post-processed-edges.mdx
💤 Files with no reviewable changes (2)
- docs/analyze-data/accept-findings.mdx
- docs/analyze-data/posture-page.mdx
|
|
||
| - **Attack Paths data**: An expandable list of Attack Paths showing a detailed finding description, severity, principals involved, impact, and remediation plan. | ||
|
|
||
| >**DELETE ME**: Would like to use some kind of visual. How much of the UI can we show? Should we use an abstract image rather than an actual screenshot to avoid revealing findings? |
Contributor
There was a problem hiding this comment.
Remove internal “DELETE ME” note before publishing.
Line 20 is an internal drafting note and should not appear in user-facing docs.
🧹 Proposed fix
->**DELETE ME**: Would like to use some kind of visual. How much of the UI can we show? Should we use an abstract image rather than an actual screenshot to avoid revealing findings?📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| >**DELETE ME**: Would like to use some kind of visual. How much of the UI can we show? Should we use an abstract image rather than an actual screenshot to avoid revealing findings? |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/analyze-data/findings/attack-paths.mdx` at line 20, Remove the internal
drafting note "**DELETE ME**: Would like to use some kind of visual..." from the
attack-paths.mdx content (the visible callout at line containing "**DELETE
ME**"); replace it with a neutral, user-facing callout requesting a
non-sensitive visual or abstract illustration (e.g., "Consider adding an
abstract visual or diagram to illustrate attack paths without revealing
sensitive findings") so the page contains no internal editorial markers and
still prompts for safe visuals.
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
1 participant
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.
Purpose
This pull request (PR) addresses a gap in doc coverage for the Attack Paths page in BloodHound Enterprise as described in BP-2488.
It also proposes a new structure for the Analyze Attack Path Data section in the left nav:
Note
I think we should move the BloodHound Configuration page to the Manage BloodHound section, but that's out of scope for this PR. It'll probably happen soon when I document the API key expiration feature.
Staging
https://specterops-bp-2488-findings.mintlify.app/analyze-data/findings/attack-paths
TODOs
Summary by CodeRabbit