Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion code-review/billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Code Review has a free trial for new organizations.
<Steps>
<Step title="Open Billing">Go to **Billing** as an organization owner.</Step>
<Step title="Start the trial">
Start the trial. No payment method is required during the free trial.
Review and accept the terms of service and start the trial. No payment method
is required during the free trial.
</Step>
<Step title="Start the Code Review trial">
Once the trial is active, Hacktron starts running code reviews on all
Expand Down
10 changes: 10 additions & 0 deletions code-review/findings-feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ Findings are posted inline on GitHub PRs and GitLab MRs when a vulnerability is
</p>
</Tip>

## Public repositories

When a repository is **public**, Hacktron keeps sensitive finding details out of the public pull request thread. In the summary review comment, findings outside the changed lines no longer show their title, description, proof-of-concept, or file location. Instead, you see a count and a link back to the finding in Hacktron.

Inline comments on the diff itself are unaffected, so findings on the changed lines still appear in full. **Private and internal repositories are unchanged** and show complete finding details as usual.

## Triage comments

You can leave triage comments on findings to help improve future reviews. This helps Hacktron understand
Expand Down Expand Up @@ -75,6 +81,10 @@ so reviews get sharper, with fewer false positives and more of the bugs that act
</Tab>
</Tabs>

## Checks update on triage

Triaging a finding updates the pull request check right away. Marking a finding as a false positive or accepted risk removes it from the [fail-on gate](/code-review/config#fail-the-check-on-findings), so the GitHub check (or GitLab commit status) flips back to passing with no re-run. Reopen the finding and the check fails again to match.

## Feedback loop

Triage feedback helps Hacktron adapt to your codebase. Comments and project rules
Expand Down
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
"group": "Overview",
"pages": [
"index",
"platform/overview"
"platform/overview",
"platform/dashboard"
]
},
{
Expand Down
Binary file added images/dashboard_scan_volume.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions platform/dashboard.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Dashboard"
description: "Track Code Review and Whitebox scan activity across your organization from the Hacktron dashboard."
---

The dashboard splits your work into tabs, so each view shows the metrics that
matter for it:

- **Overview**
- **PR Review**
- **Whitebox Scan**

## Scan volume

The **Scan volume across time** widget shows how many scans ran over time as a
stacked bar chart. Each bar is one day, split into **PR Review** and **Whitebox
Scan** counts. Hover a bar to see the per-day breakdown.

<img src="/images/dashboard_scan_volume.png" alt="Scan volume across time chart on the dashboard" />

## Next steps

<Columns cols={2}>
<Card title="Findings and feedback" icon="comment" href="/code-review/findings-feedback">
See where findings are posted and how triage improves reviews.
</Card>
<Card title="Whitebox quickstart" icon="magnifying-glass" href="/white-box-pentest/quickstart">
Start a whitebox scan from a repository or an uploaded archive.
</Card>
</Columns>
5 changes: 5 additions & 0 deletions white-box-pentest/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ Before you start, make sure the organization has:

<img src="/images/whitebox_select_repository.png" alt="Select the primary repository and branch for the scan" />

<Note>
If you start the scan from an uploaded archive instead of a connected
repository, the scan takes the archive's filename as its name.
</Note>

</Step>
<Step title="Add runtime context">
Add target URLs, login steps, test credentials, areas to emphasize, and any
Expand Down