Skip to content

docs: add how-remediation-works page with Mermaid diagrams and tabbed commands#548

Merged
sonukapoor merged 4 commits into
mainfrom
docs/issue-547-how-remediation-works
Jun 4, 2026
Merged

docs: add how-remediation-works page with Mermaid diagrams and tabbed commands#548
sonukapoor merged 4 commits into
mainfrom
docs/issue-547-how-remediation-works

Conversation

@sonukapoor
Copy link
Copy Markdown
Collaborator

Closes #547

Adds a new visual documentation page explaining how CVE Lite CLI determines fix commands, and upgrades the existing remediation strategy page to the same standard.

Changes

New page — how-remediation-works.mdx:

  • Explains lockfile fundamentals and version ranges for non-expert readers
  • Covers all four fix strategies with Mermaid dependency tree diagrams
  • Tabbed package manager commands (npm/pnpm/yarn/bun) on every command block
  • Sections for workspaces, multiple parents (same version and different versions), offline mode, and a full decision flowchart
  • Wired into sidebar under "Fix Issues"

Upgraded — remediation-strategy.mdx:

  • Converted from .md to .mdx
  • All project → parent → vulnerable text chains replaced with Mermaid diagrams
  • Multi-line command blocks replaced with tabbed package manager views
  • Cross-link to new how-remediation-works page at top and bottom

Infrastructure:

  • Mermaid support enabled in Docusaurus config
  • @docusaurus/theme-mermaid installed
  • Edge label padding added to custom.css

Validation

  • npm run build (website)
  • Previewed locally via npm start

Explains lockfile fundamentals, direct vs transitive dependency
classification, and all four fix strategies (direct upgrade, lockfile
refresh, parent upgrade, best-effort) with Mermaid dependency tree
diagrams and tabbed package manager commands for npm/pnpm/yarn/bun.
Also covers workspaces, multiple parents, offline mode, and a full
decision flowchart.

Closes #547
…mmands

Converts remediation-strategy.md to MDX format, adds Mermaid diagrams
for all dependency chain examples, and replaces multi-line command
blocks with tabbed package manager commands (npm/pnpm/yarn/bun).
Adds cross-link to the new how-remediation-works page.
@sonukapoor sonukapoor force-pushed the docs/issue-547-how-remediation-works branch from 5bea75e to 7efc1f3 Compare June 4, 2026 11:35
@sonukapoor sonukapoor merged commit 2a61328 into main Jun 4, 2026
6 checks passed
@sonukapoor sonukapoor deleted the docs/issue-547-how-remediation-works branch June 4, 2026 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add how-remediation-works page explaining fix command logic with Mermaid diagrams

1 participant