WDS documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
Following the documentation (https://lit.dev/docs/tools/development/#web-dev-server) a had some issues.
- The naming of the file web-dev-server.config.js gave me troubles. Rename the file extension to .mjs solve the issue.
- The `esbuildTarget: 'auto'` in the config resulted in an error, due to a missing installation of @web/dev-server-esbuild.
I also wonder if it would not be wise to refer to the WDS documentation at https://lit.dev/docs/getting-started/#install-locally-from-npm. Otherwise people who are not familiar with bare specifiers could get stuck / frustrated very early in the process of learning lit.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Web Dev Server section at https://lit.dev/docs/tools/development/#web-dev-server and compare it with the local npm installation guidance at https://lit.dev/docs/getting-started/#install-locally-from-npm. Clarify the web-dev-server.config.js extension, explain the @web/dev-server-esbuild requirement for esbuildTarget: 'auto', and add the relevant installation guidance or link; done means a new reader can follow the setup without these errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100