Skip to content

Conversation

@jeff-matthews
Copy link
Contributor

@jeff-matthews jeff-matthews commented Jan 16, 2026

Purpose

This pull request (PR) cherry picks smaller, targeted commits from #155 to untie the proposed OpenGraph quickstart from the v8.5.0 release.

Summary by CodeRabbit

  • Documentation
    • Introduced OpenGraph documentation covering new platform capabilities
    • Expanded coverage to include identity services beyond AD/Entra ID (GitHub, Okta, Jamf)
    • Updated FAQ with specific guidance on custom nodes and edges capabilities
    • Enhanced visual presentation across documentation pages

✏️ Tip: You can customize this high-level summary in your review settings.

@jeff-matthews jeff-matthews self-assigned this Jan 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 16, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This PR refines BloodHound documentation by updating OpenGraph-related content. Changes include clarified terminology in the introduction, icon property updates across documentation files, and more nuanced FAQ content explaining partial support for custom nodes & edges with Search and Pathfinding features.

Changes

Cohort / File(s) Summary
Icon and markup updates
docs/home.mdx, docs/opengraph/overview.mdx
Icon prop changed from "diagram-project" to "circle-nodes" in home.mdx; overview.mdx updated with icon name changes (gear → brackets-curly for Schema card, gears → brackets-curly for API card) and formatting adjustments to card markup.
Content clarification
docs/get-started/introduction.mdx, docs/opengraph/faq.mdx
Introduction scope refined to focus on Active Directory and Entra ID with OpenGraph capabilities description; FAQ updated to replace blanket "not supported" statements with nuanced details on partial Search support (v8.50+) and guidance on Pathfinding workarounds.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • Scoubi
  • craigw-SO

Poem

🐰 With circle-nodes and brackets curled,
OpenGraph maps the hybrid world,
Custom nodes now partly gleam,
Search supports our data dream,
Docs refined, the path more clear! 📊

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title clearly identifies the main change: partial OpenGraph documentation updates for v8.5.0, which aligns with all file changes (introduction, home, FAQ, overview).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jeff-matthews jeff-matthews added documentation Improvements or additions to documentation v8.5.0 labels Jan 16, 2026
Copy link
Contributor

@StephenHinck StephenHinck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great

@jeff-matthews
Copy link
Contributor Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 16, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/opengraph/faq.mdx`:
- Line 34: The version string "v8.50" in the OpenGraph FAQ line should be
changed to a semver-consistent format; locate the sentence containing "v8.50" in
the OpenGraph nodes search paragraph and replace it with "v8.5.0" (or "v8.5" if
shorter) so the documentation uses standard semantic versioning.
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc7a93c and eb54499.

📒 Files selected for processing (4)
  • docs/get-started/introduction.mdx
  • docs/home.mdx
  • docs/opengraph/faq.mdx
  • docs/opengraph/overview.mdx
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: jeff-matthews
Repo: SpecterOps/bloodhound-docs PR: 89
File: docs/resources/edges/az-role-approver.mdx:14-14
Timestamp: 2025-10-27T15:00:33.251Z
Learning: In the bloodhound-docs repository, documentation content derived from HelpTexts in the code should not be editorially changed unless there's an egregious error. Minor stylistic improvements should be submitted as PRs to the source code instead of being made directly in the documentation.
Learnt from: StephenHinck
Repo: SpecterOps/bloodhound-docs PR: 67
File: docs/collect-data/enterprise-collection/privileged-collection.mdx:7-7
Timestamp: 2025-10-02T18:01:39.059Z
Learning: In the BloodHound documentation repository, "BloodHound" as a standalone name refers to the entire product family and is appropriate to use when content applies to all products in the family (Enterprise and Community Edition). "BloodHound Enterprise" should be used only when referring specifically to Enterprise-only features or capabilities.
📚 Learning: 2025-08-08T15:57:55.743Z
Learnt from: StephenHinck
Repo: SpecterOps/bloodhound-docs PR: 42
File: docs/install-data-collector/install-azurehound/system-requirements.mdx:70-73
Timestamp: 2025-08-08T15:57:55.743Z
Learning: For AzureHound docs (docs/install-data-collector/install-azurehound/system-requirements.mdx), prefer explicitly stating:
- Directory Reader must be permanently active (not PIM-eligible only).
- Microsoft Graph application permissions (Directory.Read.All, RoleManagement.Read.All) require admin consent.
- Azure Reader role phrasing: “on all Azure subscriptions, ideally assigned at the tenant root group (root management group) scope.”

Applied to files:

  • docs/get-started/introduction.mdx
📚 Learning: 2025-10-02T18:01:39.059Z
Learnt from: StephenHinck
Repo: SpecterOps/bloodhound-docs PR: 67
File: docs/collect-data/enterprise-collection/privileged-collection.mdx:7-7
Timestamp: 2025-10-02T18:01:39.059Z
Learning: In the BloodHound documentation repository, "BloodHound" as a standalone name refers to the entire product family and is appropriate to use when content applies to all products in the family (Enterprise and Community Edition). "BloodHound Enterprise" should be used only when referring specifically to Enterprise-only features or capabilities.

Applied to files:

  • docs/get-started/introduction.mdx
📚 Learning: 2025-08-22T22:40:24.105Z
Learnt from: StephenHinck
Repo: SpecterOps/bloodhound-docs PR: 53
File: docs/analyze-data/posture-page.mdx:33-41
Timestamp: 2025-08-22T22:40:24.105Z
Learning: BloodHound Enterprise has exactly four severity levels for attack paths: CRITICAL (95%–100%), HIGH (80%–94%), MODERATE (40%–79%), and LOW (0%–39%). There is no "NONE" or similar severity level for 0% exposure.

Applied to files:

  • docs/get-started/introduction.mdx
🪛 LanguageTool
docs/get-started/introduction.mdx

[style] ~7-~7: Consider a different adjective to strengthen your wording.
Context: ...ackers (red teams) use BloodHound for a deeper understanding of privileged relationshi...

(DEEP_PROFOUND)

🔇 Additional comments (3)
docs/home.mdx (1)

121-123: Icon update aligns with OpenGraph visuals.

No concerns with this change.

docs/get-started/introduction.mdx (1)

7-12: Verify OpenGraph version/capability statements.

Please confirm the “introduced in v8.0” timing and the listed capabilities/examples match current release notes and product behavior to avoid doc drift.

docs/opengraph/overview.mdx (1)

7-24: Confirm new icon names are valid in the icon set.

Please double-check that circle-nodes and brackets-curly resolve in the current Mintlify icon set to avoid missing icons at render time.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

@jeff-matthews jeff-matthews merged commit 057ce6a into release/v8.5.0 Jan 16, 2026
3 checks passed
@jeff-matthews jeff-matthews deleted the BP-2211-opengraph-partial-updates branch January 16, 2026 18:57
@github-actions github-actions bot locked and limited conversation to collaborators Jan 16, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation v8.5.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants