Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 3.47 KB

File metadata and controls

68 lines (46 loc) · 3.47 KB

CVE Radar — Extended Documentation

Multi-source vulnerability monitoring for your infrastructure stack. This site is the complete product guide in six languages, with diagrams, glossary, UI walkthrough, and an interactive API explorer.

CVE Radar — Web UI after full scan{ .product-demo-shot } How it works: define your stack → run a full scan (NVD, OSV, GitHub, CISA KEV, RSS) → review the dashboard, drill into vulnerabilities by tool or severity, enable watch for fast polling. Screenshot in English; see User interface for all six UI locales.


About this documentation

The extended-docs/ site is the full product guide: connected prose per chapter, Mermaid diagrams with zoom, a dedicated Glossary tab, and an API Explorer tab for interactive mock requests.

Command Purpose
cd extended-docs && make install Python venv + MkDocs Material
make serve Live preview at http://127.0.0.1:8000
make check Strict build (CI)
make verify Build + Mermaid/zoom asset checks

Language guides

Choose a language tab in the top navigation bar:

Language First chapter
English Overview
فارسی نمای کلی
العربية نظرة عامة
Русский Обзор
中文 概述
Français Vue d'ensemble

Shared definitions: Glossary (multilingual table).


Product highlights

  • Full scan — NVD, OSV, GitHub Advisories, CISA KEV, security RSS (The Hacker News, TuxCare).
  • Watch mode — fast polling on OSV + GitHub + RSS without NVD delay.
  • Six UI locales — fa, en, ar, ru, zh, fr with RTL/LTR and locale-aware dates.
  • CVE text translation — optional auto-translate titles/descriptions to the active UI language.
  • Unified sidebar — navigation, per-tool CVE filters, source freshness, scan summary.
  • Accessibility — adjustable base font size (85%–140%) persisted in the browser.
  • Setup wizard (v1.1.0) — first-run configuration before the dashboard.
  • Scan cache — reload last scan results when the stack matches (no mandatory full scan every session).
  • Server rate limits — separate scan/watch quotas; see Configuration.

Current release: v1.2.1

Doc maintenance: agent rule code-to-docs-sync keeps this site aligned with code changes (six locales + glossary).

Interactive tab

  • API ExplorerSwagger UI for the OpenAPI 3.1 contract (Try it out with browser mocks on the docs site).

Repository links

  • Application README: README.md
  • Cursor rules & skills: agent/README.md
  • Legacy short docs: docs/ (MkDocs) — superseded by this extended site for full coverage.

Built with MkDocs Material · Mermaid click-to-zoom