Problem
The public docs/index.html landing page is becoming too long and is starting to serve too many purposes at once: product homepage, feature pitch, documentation hub, comparison entry point, remediation explainer, and case-study index.
That makes it harder for visitors to quickly understand the product and harder to keep adding important features without making the homepage feel crowded.
Why this matters
CVE Lite CLI now has several differentiators that deserve clear public explanation:
- local-first developer workflow
- parent-aware transitive remediation guidance
- usage-aware reachability scanning
- offline advisory DB support
- HTML reports and CI workflows
- real-world case studies
Putting all of that into one HTML page creates a weaker UX over time. A more polished public site would better support users, contributors, OWASP reviewers, and people comparing the tool against alternatives.
Proposed direction
Refactor the documentation site into a small multi-page website instead of one long landing page that links mostly to Markdown files.
Potential structure:
index.html — concise homepage focused on the main value proposition and top differentiators
remediation.html — parent-aware remediation, direct vs transitive strategy, command selection
offline.html — offline advisory DB workflow
reports.html — HTML report and verbose output explanation
comparison.html — practical comparison with Dependabot, npm audit, OSV-Scanner, Snyk, Socket
case-studies.html — index of real-world case studies
docs.html or guides.html — full guide index for GitHub docs and contributor resources
Markdown files can remain useful for GitHub readers, but the public site should expose important concepts as first-class HTML pages with consistent navigation.
Scope
This should be a focused docs/UX cleanup, not a redesign of the whole project brand.
Suggested first pass:
- Define the site information architecture.
- Split the longest homepage content into 2-4 dedicated HTML guide pages.
- Keep
index.html shorter and more conversion-oriented.
- Add consistent navigation between the new pages.
- Preserve links to the existing Markdown docs for contributors and GitHub readers.
- Avoid duplicating content so heavily that future updates become hard to maintain.
Acceptance criteria
- Homepage is shorter and easier to scan.
- Parent-aware remediation remains prominent but links to a dedicated page for details.
- Existing Markdown docs remain accessible.
- Public docs site has clear navigation across the new pages.
- No generated or local-only files are committed.
Problem
The public
docs/index.htmllanding page is becoming too long and is starting to serve too many purposes at once: product homepage, feature pitch, documentation hub, comparison entry point, remediation explainer, and case-study index.That makes it harder for visitors to quickly understand the product and harder to keep adding important features without making the homepage feel crowded.
Why this matters
CVE Lite CLI now has several differentiators that deserve clear public explanation:
Putting all of that into one HTML page creates a weaker UX over time. A more polished public site would better support users, contributors, OWASP reviewers, and people comparing the tool against alternatives.
Proposed direction
Refactor the documentation site into a small multi-page website instead of one long landing page that links mostly to Markdown files.
Potential structure:
index.html— concise homepage focused on the main value proposition and top differentiatorsremediation.html— parent-aware remediation, direct vs transitive strategy, command selectionoffline.html— offline advisory DB workflowreports.html— HTML report and verbose output explanationcomparison.html— practical comparison with Dependabot, npm audit, OSV-Scanner, Snyk, Socketcase-studies.html— index of real-world case studiesdocs.htmlorguides.html— full guide index for GitHub docs and contributor resourcesMarkdown files can remain useful for GitHub readers, but the public site should expose important concepts as first-class HTML pages with consistent navigation.
Scope
This should be a focused docs/UX cleanup, not a redesign of the whole project brand.
Suggested first pass:
index.htmlshorter and more conversion-oriented.Acceptance criteria