Skip to content

Commit

Permalink
Docs: reference findings via UI
Browse files Browse the repository at this point in the history
  • Loading branch information
MWedl committed Jan 23, 2025
1 parent e1d237a commit e0d6caa
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
Binary file removed docs/docs/images/finding_id.png
Binary file not shown.
Binary file added docs/docs/images/reference-finding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/docs/reporting/references.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ As you see in <ref to="sqli" /> (e.g. rendered as "Figure 3")
```

## Reference Findings
You need the finding ID of the finding you want to reference.
You need the finding ID of the finding you want to reference.
The markdown editor toolbar in projects provides a button to insert finding references.

![Insert findng reference](../images/finding_reference.png)

1. Open the other finding that should be linked
2. Copy the last UUID from the URL ![Grab the finding ID](../images/finding_id.png)

```md title="Markdown"
See [](#00000000-0000-0000-0000-000000000000)... (e.g. rendered as "1.3 SQL injection")
Expand Down

0 comments on commit e0d6caa

Please sign in to comment.