jspm / jspm.org

jspm.org website
https://jspm.org
13 stars 17 forks source link

docs: roadmap for CLI relaunch #23

Closed Bubblyworld closed 1 year ago

Bubblyworld commented 1 year ago

A list of docs-related stuff we need to get done for the JSPM CLI relaunch:

Some other things:

Bubblyworld commented 1 year ago

@guybedford is going to write a blog post hailing the tech as well, which will go somewhere on jspm.org.

Bubblyworld commented 1 year ago

From our discussion yesterday:

  1. Restructure the sidebar of jspm.org:

    • JSPM CLI

      • Introduction
      • Workflows
      • Docs
    • JSPM.IO CDN

      • Introduction
      • Workflows
      • API
    • API Docs

      • jspm
      • Generator
      • Import Map
  2. Chuck the resources sidebar.

  3. Shorten blogs to latest few.

  4. API docs landing page should be duplicate of README on github (typedoc already does this)

Bubblyworld commented 1 year ago

Landing page for CLI (introduction) should consist of a brief intro, and then a few key visualised points illustrating the main features of the CLI. Should link to corresponding workflows on the (workflows) page.