docs: added vite-press docs (#4)
Co-authored-by: Sharang Parnerkar <parnerkarsharang@gmail.com> Reviewed-on: #4
This commit was merged in pull request #4.
This commit is contained in:
35
docs/features/overview.md
Normal file
35
docs/features/overview.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Dashboard Overview
|
||||
|
||||
The Overview page is the landing page of the Compliance Scanner dashboard. It gives you a high-level view of your security posture across all tracked repositories.
|
||||
|
||||
## Statistics
|
||||
|
||||
The top section displays key metrics:
|
||||
|
||||
| Metric | Description |
|
||||
|--------|-------------|
|
||||
| **Repositories** | Total number of tracked repositories |
|
||||
| **Total Findings** | Combined count of all security findings |
|
||||
| **Critical** | Findings with critical severity |
|
||||
| **High** | Findings with high severity |
|
||||
| **Medium** | Findings with medium severity |
|
||||
| **Low** | Findings with low severity |
|
||||
| **Dependencies** | Total SBOM entries across all repositories |
|
||||
| **CVE Alerts** | Active CVE alerts from dependency monitoring |
|
||||
| **Tracker Issues** | Issues created in external trackers (GitHub, GitLab, Jira) |
|
||||
|
||||
## Severity Distribution
|
||||
|
||||
A visual bar chart shows the distribution of findings by severity level, giving you an immediate sense of your risk profile.
|
||||
|
||||
## Recent Scan Runs
|
||||
|
||||
The bottom section lists the 10 most recent scan runs across all repositories, showing:
|
||||
|
||||
- Repository name
|
||||
- Scan status (queued, running, completed, failed)
|
||||
- Current phase
|
||||
- Number of findings discovered
|
||||
- Timestamp
|
||||
|
||||
This helps you monitor scanning activity and quickly spot failures.
|
||||
Reference in New Issue
Block a user