lit / lit/lit.dev

How can we make it more clear that we support multiple tools workflows?

Open
#580 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

While we try to support basically any workflow or tools with Lit - because it's just a plain JS library - this point seems to not make it across to some lit.dev visitors. They sometimes still assume that Lit is more like a framework (which like React, Vue, Angular, and Svelte, require compilers) or other library that require specific tools.

Our Getting Started, Tools Overview, and Tools Requirements page intend to make it clear what we require and work with, but they organization and level of detail might be a bit drilled in and not get the high-level points across enough. We may also be expecting reader to synthesize certain conclusions rather than speaking directly to common workflows.

It might be possible to include some text for common-enough workflows to highlight how we work with them. Workflows (really personas) might include:
* npm, but buildless
* non-npm
* "modern" dev servers like `@web/dev-server`, Vite or Snowpack
* Webpack, Rollup, etc., and their dev servers

This is probably overlapping but separate from our goal of having framework-specific guides. The React guide might mention adding Lit to create-react-app or Next.js. The Angular guide would talk about whatever dev server/build system Angular uses, etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Getting Started, Tools Overview, and Tools Requirements pages to understand their current organization and level of detail. Review how the listed npm, non-npm, modern dev-server, and bundler workflows are represented, then define documentation changes that make the supported workflows explicit and easy to identify.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, rollup, vite, webpack
Domain
developer-experience, documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.