docs: rewrite user-facing documentation with screenshots (#11)
All checks were successful
CI / Clippy (push) Successful in 4m56s
CI / Security Audit (push) Successful in 1m48s
CI / Tests (push) Successful in 5m36s
CI / Deploy MCP (push) Has been skipped
CI / Format (push) Successful in 6s
CI / Detect Changes (push) Successful in 4s
CI / Deploy Agent (push) Successful in 2s
CI / Deploy Dashboard (push) Successful in 2s
CI / Deploy Docs (push) Successful in 3s
All checks were successful
CI / Clippy (push) Successful in 4m56s
CI / Security Audit (push) Successful in 1m48s
CI / Tests (push) Successful in 5m36s
CI / Deploy MCP (push) Has been skipped
CI / Format (push) Successful in 6s
CI / Detect Changes (push) Successful in 4s
CI / Deploy Agent (push) Successful in 2s
CI / Deploy Dashboard (push) Successful in 2s
CI / Deploy Docs (push) Successful in 3s
This commit was merged in pull request #11.
This commit is contained in:
@@ -1,10 +1,12 @@
|
||||
# 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.
|
||||
The Overview page is the landing page of Certifai. It gives you a high-level view of your security posture across all tracked repositories.
|
||||
|
||||
## Statistics
|
||||

|
||||
|
||||
The top section displays key metrics:
|
||||
## Stats Cards
|
||||
|
||||
The top section displays key metrics at a glance:
|
||||
|
||||
| Metric | Description |
|
||||
|--------|-------------|
|
||||
@@ -14,22 +16,32 @@ The top section displays key metrics:
|
||||
| **High** | Findings with high severity |
|
||||
| **Medium** | Findings with medium severity |
|
||||
| **Low** | Findings with low severity |
|
||||
| **Dependencies** | Total SBOM entries across all repositories |
|
||||
| **Dependencies** | Total SBOM packages across all repositories |
|
||||
| **CVE Alerts** | Active CVE alerts from dependency monitoring |
|
||||
| **Tracker Issues** | Issues created in external trackers (GitHub, GitLab, Jira) |
|
||||
| **Tracker Issues** | Issues created in external trackers (GitHub, GitLab, Gitea, Jira) |
|
||||
|
||||
These cards update after each scan completes, so you always see the current state.
|
||||
|
||||
## Severity Distribution
|
||||
|
||||
A visual bar chart shows the distribution of findings by severity level, giving you an immediate sense of your risk profile.
|
||||
A visual chart shows the distribution of findings by severity level across all your repositories. This gives you an immediate sense of your risk profile -- whether your findings are mostly informational or if there are critical issues that need attention.
|
||||
|
||||
## AI Chat Cards
|
||||
|
||||
The overview includes quick-access cards for the AI Chat feature. Each card represents a repository that has embeddings built, letting you jump directly into a conversation about that codebase. See [AI Chat](/features/ai-chat) for details.
|
||||
|
||||
## MCP Server Cards
|
||||
|
||||
If you have MCP servers registered, they appear on the overview page with their status and connection details. This lets you quickly check that your MCP integrations are running. See [MCP Integration](/features/mcp-server) for details.
|
||||
|
||||
## Recent Scan Runs
|
||||
|
||||
The bottom section lists the 10 most recent scan runs across all repositories, showing:
|
||||
The bottom section lists the most recent scan runs across all repositories, showing:
|
||||
|
||||
- Repository name
|
||||
- Scan status (queued, running, completed, failed)
|
||||
- Current phase
|
||||
- Number of findings discovered
|
||||
- Timestamp
|
||||
- Timestamp and duration
|
||||
|
||||
This helps you monitor scanning activity and quickly spot failures.
|
||||
This helps you monitor scanning activity and quickly spot failures or long-running scans.
|
||||
|
||||
Reference in New Issue
Block a user