[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.

Assessment

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

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.

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.

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

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.

More from lit/lit.dev

All issues in lit/lit.dev

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.