lit / lit/lit.dev

[docs] Document the @lit-labs/ssr-dom-shim package on docs/ssr/dom-emulation/

Open Beginner friendly
#1,469 0 comments 0 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

The SSR Dom Emulation page at https://lit.dev/docs/ssr/dom-emulation/ doesn't include the full set of APIs we currently emulate. Nor does it mention what's in the automatic shim vs the `@lit-labs/ssr-dom-shim` package.

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 docs/ssr/dom-emulation/ and review the existing SSR DOM emulation page. Compare its API coverage with the currently emulated APIs, then document what is provided by the automatic shim versus the @lit-labs/ssr-dom-shim package. Done means the page covers the full API set and clearly explains both sources.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.