Add: Shortcuts documentation #135
Conversation
WalkthroughAdded a new documentation page describing BloodHound keyboard shortcuts and updated docs navigation by inserting Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/manage-bloodhound/bh-shortcuts.mdx (1)
38-38: Add newline at end of file.The file is missing a newline at the end, which is a common convention in text files.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/docs.json(1 hunks)docs/manage-bloodhound/bh-shortcuts.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
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-10-27T15:00:33.251Z
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.
Applied to files:
docs/docs.json
📚 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/docs.jsondocs/manage-bloodhound/bh-shortcuts.mdx
🪛 LanguageTool
docs/manage-bloodhound/bh-shortcuts.mdx
[grammar] ~28-~28: Use a hyphen to join words.
Context: ... F | Filter Table Data | ## Enterprise Only Shortcuts | Page | Co...
(QB_NEW_EN_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Mintlify Deployment
🔇 Additional comments (2)
docs/docs.json (1)
157-157: LGTM!The navigation entry is properly placed and correctly references the new shortcuts documentation page.
docs/manage-bloodhound/bh-shortcuts.mdx (1)
1-5: LGTM!The frontmatter is properly structured, and the use of "BloodHound" (rather than "BloodHound Enterprise") is appropriate since this documentation covers shortcuts for both Enterprise and Community Edition. Based on learnings, this follows the established convention.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/manage-bloodhound/bh-shortcuts.mdx (1)
21-21: Resolve or remove the TODO comment.The TODO comment indicates incomplete documentation. Please clarify whether the "Toggle Node Info Panel" shortcut exists and should be documented, or if this line should be removed.
🧹 Nitpick comments (2)
docs/manage-bloodhound/bh-shortcuts.mdx (2)
8-8: Minor style improvements for consistency.Consider these small refinements:
- "Shortcuts" should be lowercase in the sentence
- "Community-Edition" is typically written as "Community Edition" (without hyphen)
Apply this diff:
-These Shortcuts work on both BloodHound Enterprise and Community-Edition +These shortcuts work in both BloodHound Enterprise and Community Edition
25-25: Hyphenate compound adjective for proper grammar.When "Enterprise Only" modifies "Shortcuts" as a compound adjective, it should be hyphenated as "Enterprise-Only".
Apply this diff:
-## Enterprise Only Shortcuts +## Enterprise-Only ShortcutsBased on static analysis hints.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/manage-bloodhound/bh-shortcuts.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
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-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/manage-bloodhound/bh-shortcuts.mdx
🪛 LanguageTool
docs/manage-bloodhound/bh-shortcuts.mdx
[grammar] ~25-~25: Use a hyphen to join words.
Context: ...+ G | Reset Graph View | ## Enterprise Only Shortcuts | Page | Co...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (3)
docs/manage-bloodhound/bh-shortcuts.mdx (3)
1-5: LGTM!The front matter is properly structured with appropriate title and description.
29-31: Great job fixing the spacing issue!The spacing in "Option/Control + Shift + R" is now correct and consistent with other shortcuts.
33-35: Good fix on duplicate shortcuts!The Posture Page shortcuts are now correctly placed only in the Enterprise-Only section, resolving the duplication issue from the previous review.
Remove useless space Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/manage-bloodhound/bh-shortcuts.mdx (1)
21-21: Resolve the TODO comment.The TODO comment indicates incomplete documentation. This was flagged in a previous review as addressed, but it still appears in the current code.
🧹 Nitpick comments (2)
docs/manage-bloodhound/bh-shortcuts.mdx (2)
10-22: Consider normalizing spacing in the table.Some table rows have extra spaces before "Option/Control" (lines 14, 15, 17, 20, 21), creating inconsistent alignment in the markdown source. While this doesn't affect rendering, consistent spacing improves readability of the source file.
35-35: Add newline at end of file.The file should end with a newline character as per standard text file conventions.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/manage-bloodhound/bh-shortcuts.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
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-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/manage-bloodhound/bh-shortcuts.mdx
🪛 LanguageTool
docs/manage-bloodhound/bh-shortcuts.mdx
[grammar] ~25-~25: Use a hyphen to join words.
Context: ...+ G | Reset Graph View | ## Enterprise Only Shortcuts | Page | Co...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (2)
docs/manage-bloodhound/bh-shortcuts.mdx (2)
1-5: LGTM!The frontmatter metadata is well-structured and provides clear context for the documentation page.
32-33: Clarify duplicate shortcut across pages.Both Attack Paths Page and Posture Page use
Option/Control + Efor "Jump to Environment Selector". If this is intentional (same shortcut works on both pages), consider adding a note for clarity. Otherwise, verify that the shortcut assignments are correct.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/manage-bloodhound/bh-shortcuts.mdx (1)
25-25: Add hyphen to compound adjective."Enterprise Only" should be hyphenated as "Enterprise-Only" when used as a compound adjective modifying "Shortcuts".
Apply this diff:
-## Enterprise Only Shortcuts +## Enterprise-Only ShortcutsBased on static analysis hints from LanguageTool.
🧹 Nitpick comments (1)
docs/manage-bloodhound/bh-shortcuts.mdx (1)
35-35: Consider adding a trailing newline.The file ends without a newline character after the last line. While this doesn't affect functionality, many style guides and linters recommend ending text files with a newline for consistency and to avoid potential issues with certain tools.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/manage-bloodhound/bh-shortcuts.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
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-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/manage-bloodhound/bh-shortcuts.mdx
🪛 LanguageTool
docs/manage-bloodhound/bh-shortcuts.mdx
[grammar] ~25-~25: Use a hyphen to join words.
Context: ...+ G | Reset Graph View | ## Enterprise Only Shortcuts | Page | Co...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (3)
docs/manage-bloodhound/bh-shortcuts.mdx (3)
1-5: LGTM! Clear and well-structured front matter.The front matter is properly formatted with appropriate titles and description. The use of "BloodHound" (rather than "BloodHound Enterprise") correctly refers to the product family since the documentation covers shortcuts for both editions.
Based on learnings, "BloodHound" as a standalone name appropriately refers to the entire product family.
7-22: LGTM! Well-organized global shortcuts section.The Global Shortcuts section is clearly structured with:
- A descriptive heading that correctly identifies shortcuts available in both editions
- A clean, consistently formatted table covering global actions and Explore Page functionality
- Proper product naming that aligns with documentation standards
27-35: LGTM! Enterprise shortcuts are well-documented.The Enterprise-Only shortcuts table is properly structured and covers the Attack Paths Page and Posture Page functionality. The same shortcut (Option/Control + E) appearing for both Attack Paths Page and Posture Page is intentional, as it performs the same action on different pages.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.