extended-docs

Extended documentation — CVE Radar

Multilingual MkDocs Material site for CVE Radar. Public roadmap: README § Roadmap. Integration tests: tests/integration/.

Commands

make install   # Python venv + dependencies
make serve     # http://127.0.0.1:8000
make check     # strict build (CI)
make verify    # check + Mermaid/zoom assets

From repository root: make extended-docs-serve

Structure

Path	Content
docs/index.md	Home (language index)
docs/glossary.md	Multilingual glossary tab
docs/content/{en,fa,ar,ru,zh,fr}/	10 chapters per locale
docs/prototype/	UI walkthrough + API Explorer
docs/javascripts/	Mermaid zoom, mock API explorer
docs/assets/icons/brands/	Local brand logos (Simple Icons, favicons, MDI — not Flaticon)
docs/assets/product/	Hero screenshot on docs home + root README (app-dashboard-*.png)

Refresh icons from repo root:

npm run icons:download

Attribution: docs/assets/icons/BRANDS_ATTRIBUTION.md and public/icons/BRANDS_ATTRIBUTION.md. Refresh: npm run icons:download.

Web UI screenshots (03-user-interface)

Chapter 03 in every locale embeds four screenshots under docs/assets/ui/{en,fa,ar,ru,zh,fr}/:

File	Web UI area
01-dashboard.png	Dashboard after scan
02-vulnerabilities.png	Vulnerabilities tab
03-infrastructure.png	Infrastructure / stack
04-scan-splash.png	Full-scan progress overlay
05-setup-wizard.png	First-run setup wizard (stack step)

Product demo (docs index.md + root README.md hero image):

npm run dev   # terminal 1
DOCS_UI_BASE_URL=http://localhost:5173 npm run docs:product-demo
# Persian README: DOCS_DEMO_LOCALE=fa npm run docs:product-demo
# Both en+fa: DOCS_DEMO_ALL=1 npm run docs:product-demo

Real captures (requires dev server + Playwright Chromium):

npm run dev   # terminal 1
DOCS_UI_BASE_URL=http://localhost:5173 npm run docs:screenshots

Copies the same files into legacy docs/assets/ui/ for the shorter MkDocs site.

Placeholders (ImageMagick, for CI or offline docs):

npm run docs:screenshots:placeholders

Build locally before push: make check (same as CI).

---

Rules & skills (Cursor / Agent)

All rules and skills used for this project live in the repo (not only in gitignored .cursor/):

Path	Contents
../agent/README.md	Index — 4 rules, 17 skills, skill chain diagram
../agent/rules/	.mdc rules (extended-docs-cve, prd-extended-delivery, orthography, technical structure)
../agent/skills/	Full skill trees (extended-docs, UI prototype, API explorer, Mermaid, Persian orthography)

# After git clone — copy into .cursor/ for Cursor IDE
./scripts/sync-agent-rules-skills.sh --to-cursor