Skip to content

[FEATURE] Homepage + design doc process — VitePress site + docs/design/ + docs/plans/ convention #67

Description

@Wolfvin

Summary

Two documentation infrastructure items: (1) VitePress homepage with live demo at codelens.dev or wolfvin.github.io/CodeLens, (2) docs/design/ + docs/plans/ convention with templates + CI check requiring design doc before new feature PR.

Worker consensus (1 report — both from UnderstandAnything)

Worker Source Contribution
UnderstandAnything update!/CodeLens_vs_UnderstandAnything_Upgrade_Analysis.md U14 Design doc + implementation plan process — docs/design/template.md (problem, goal, changes, trade-offs, open questions) + docs/plans/template.md (phase-based implementation checklist). Backfill design docs for existing features. CI check: PR adding new feature must include design + plan.
UnderstandAnything same file U15 Homepage + live demo — VitePress (Vue-based, code-focused, built-in search) at codelens.dev or wolfvin.github.io/CodeLens. Sections: Hero + CTA, Features, Showcase, Install, Live Demo (analyze Wolfvin/CodeLens itself), Documentation link, Community. SEO meta + Open Graph + sitemap. Privacy-friendly analytics (Plausible). Deploy via GitHub Pages or Cloudflare Pages.

Proposed scope (P3, 4-6 weeks total — mostly content)

Phase 1 — Design doc + implementation plan convention (P2, 1-2 days setup + ongoing)

  • New docs/design/template.md with sections: Problem, Goal, Changes, Trade-offs, Open Questions
  • New docs/plans/template.md with phase-based implementation checklist
  • Backfill design docs for existing features (taint engine, MCP server, plugin system, graph model)
  • CI check via GitHub Action: PR adding new feature (detected by file pattern) must include design + plan
  • Update CONTRIBUTING.md with the new requirement

Phase 2 — VitePress homepage (P3, 2-3 weeks, mostly content)

  • New homepage/ directory with VitePress config
  • Sections:
    • Hero + CTA ("CodeLens — AI-Native Code Intelligence")
    • Features (58 commands, MCP, dashboard, taint analysis)
    • Showcase (screenshots + GIFs of dashboard, MCP integration, guard hooks)
    • Install (multi-platform per distribution issue)
    • Live Demo (analyze Wolfvin/CodeLens itself — interactive dashboard in browser)
    • Documentation link (to GitHub README + references/)
    • Community (Discord, GitHub Discussions)
  • SEO meta + Open Graph + sitemap
  • Privacy-friendly analytics (Plausible, self-hosted or cloud)
  • Deploy via GitHub Pages or Cloudflare Pages
  • CI auto-deploy on push to main (.github/workflows/deploy-homepage.yaml)

Phase 3 — Live demo (P3, 1-2 weeks, depends on Phase 2 + dashboard issue)

  • Interactive dashboard in browser (depends on dashboard issue Phase 1)
  • Analyze Wolfvin/CodeLens itself as the demo project
  • Pre-built .codelens/ registry committed to demo branch
  • WASM-based scan (depends on tree-sitter WASM from [FEATURE] 158-language support via universal tree-sitter grammar loader #18 expansion) for in-browser execution
  • OR server-side scan with rate limiting

Acceptance criteria

  • Phase 1: docs/design/ and docs/plans/ directories exist with templates
  • Phase 1: CI check fails PR without design doc for new feature
  • Phase 1: 3+ existing features backfilled with design docs
  • Phase 2: homepage deployed at codelens.dev or wolfvin.github.io/CodeLens
  • Phase 2: homepage is mobile responsive
  • Phase 3: live demo loads in <5s and shows interactive dashboard

License / IP note

VitePress is MIT-licensed. Plausible analytics is GPL-3.0 (self-host) or SaaS. No external code copy issues.

Related

  • Phase 2 install section depends on distribution issue (multi-channel install)
  • Phase 3 depends on dashboard issue Phase 1 (interactive dashboard)

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions