[all] A bunch of README updates #4997

justinfagnani · 2025-05-22T01:50:55Z

Cleans up notices about old prereleases, adds badges and doc links, adds docs to observers.

Fixes #4996

Cleans up notices about old prereleases, adds badges and doc links, adds docs to observers.

changeset-bot · 2025-05-22T01:50:59Z

🦋 Changeset detected

Latest commit: a0f91b9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages

Name	Type
@lit-labs/virtualizer	Patch
@lit/reactive-element	Patch
@lit-labs/observers	Patch
@lit-labs/signals	Patch
@lit-labs/motion	Patch
lit-element	Patch
lit-html	Patch
@lit/context	Patch
@lit/react	Patch
@lit/task	Patch
lit	Patch
@lit-internal/test-elements-react	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-05-22T01:51:18Z

📊 Tachometer Benchmark Results

Summary

nop-update

this-change, tip-of-tree, previous-release: unsure 🔍 -15% - +3% (-2.07ms - +0.45ms)
^{this-change vs tip-of-tree}

render

this-change: 44.12ms - 56.59ms
this-change, tip-of-tree, previous-release: unsure 🔍 -2% - +6% (-0.28ms - +1.15ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -2% - +1% (-0.61ms - +0.28ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -15% - +43% (-6.53ms - +20.59ms)
^{this-change vs tip-of-tree}

update

this-change: 477.13ms - 483.09ms
this-change, tip-of-tree, previous-release: unsure 🔍 -5% - +5% (-1.75ms - +1.89ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -2% - +2% (-1.24ms - +1.45ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -1% - +1% (-5.83ms - +4.11ms)
^{this-change vs tip-of-tree}

update-reflect

this-change: 460.10ms - 464.40ms
this-change, tip-of-tree, previous-release: unsure 🔍 -1% - +1% (-2.58ms - +4.82ms)
^{this-change vs tip-of-tree}

Results

this-change

Browser: chrome-headless 136.0.0.0
Sample size: 50
Built by: Benchmarks #6784
Commit: a0f91b9

render

Version	Avg time	vs
	44.12ms - 56.59ms	-

update

Version	Avg time	vs
	477.13ms - 483.09ms	-

update-reflect

Version	Avg time	vs
	460.10ms - 464.40ms	-

this-change, tip-of-tree, previous-release

Browser: chrome-headless 136.0.0.0
Sample size: 30
Built by: Benchmarks #6784
Commit: a0f91b9

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	18.83ms - 19.87ms	-	unsure 🔍 -2% - +6% -0.28ms - +1.15ms	unsure 🔍 -1% - +6% -0.21ms - +1.18ms
tip-of-tree tip-of-tree	18.43ms - 19.40ms	unsure 🔍 -6% - +1% -1.15ms - +0.28ms	-	unsure 🔍 -3% - +4% -0.62ms - +0.72ms
previous-release previous-release	18.40ms - 19.33ms	unsure 🔍 -6% - +1% -1.18ms - +0.21ms	unsure 🔍 -4% - +3% -0.72ms - +0.62ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	36.11ms - 38.78ms	-	unsure 🔍 -5% - +5% -1.75ms - +1.89ms	unsure 🔍 -7% - +4% -2.51ms - +1.63ms
tip-of-tree tip-of-tree	36.14ms - 38.61ms	unsure 🔍 -5% - +5% -1.89ms - +1.75ms	-	unsure 🔍 -7% - +4% -2.52ms - +1.50ms
previous-release previous-release	36.30ms - 39.47ms	unsure 🔍 -4% - +7% -1.63ms - +2.51ms	unsure 🔍 -4% - +7% -1.50ms - +2.52ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	11.81ms - 13.55ms	-	unsure 🔍 -15% - +3% -2.07ms - +0.45ms	unsure 🔍 -11% - +8% -1.40ms - +1.07ms
tip-of-tree tip-of-tree	12.58ms - 14.40ms	unsure 🔍 -4% - +17% -0.45ms - +2.07ms	-	unsure 🔍 -5% - +15% -0.62ms - +1.91ms
previous-release previous-release	11.97ms - 13.72ms	unsure 🔍 -9% - +11% -1.07ms - +1.40ms	unsure 🔍 -14% - +4% -1.91ms - +0.62ms	-

this-change, tip-of-tree, previous-release

Browser: chrome-headless 136.0.0.0
Sample size: 50
Built by: Benchmarks #6784
Commit: a0f91b9

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	34.64ms - 35.17ms	-	unsure 🔍 -2% - +1% -0.61ms - +0.28ms	unsure 🔍 -2% - +1% -0.75ms - +0.25ms
tip-of-tree tip-of-tree	34.71ms - 35.43ms	unsure 🔍 -1% - +2% -0.28ms - +0.61ms	-	unsure 🔍 -2% - +1% -0.63ms - +0.48ms
previous-release previous-release	34.73ms - 35.58ms	unsure 🔍 -1% - +2% -0.25ms - +0.75ms	unsure 🔍 -1% - +2% -0.48ms - +0.63ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	70.40ms - 72.48ms	-	unsure 🔍 -2% - +2% -1.24ms - +1.45ms	unsure 🔍 -2% - +2% -1.36ms - +1.45ms
tip-of-tree tip-of-tree	70.48ms - 72.19ms	unsure 🔍 -2% - +2% -1.45ms - +1.24ms	-	unsure 🔍 -2% - +2% -1.34ms - +1.22ms
previous-release previous-release	70.44ms - 72.35ms	unsure 🔍 -2% - +2% -1.45ms - +1.36ms	unsure 🔍 -2% - +2% -1.22ms - +1.34ms	-

this-change, tip-of-tree, previous-release

Browser: chrome-headless 136.0.0.0
Sample size: 50
Built by: Benchmarks #6784
Commit: a0f91b9

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	47.37ms - 67.50ms	-	unsure 🔍 -15% - +43% -6.53ms - +20.59ms	unsure 🔍 -29% - +18% -17.86ms - +11.09ms
tip-of-tree tip-of-tree	41.31ms - 59.49ms	unsure 🔍 -34% - +10% -20.59ms - +6.53ms	-	unsure 🔍 -38% - +3% -24.23ms - +3.39ms
previous-release previous-release	50.42ms - 71.22ms	unsure 🔍 -20% - +32% -11.09ms - +17.86ms	unsure 🔍 -9% - +51% -3.39ms - +24.23ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	474.72ms - 481.37ms	-	unsure 🔍 -1% - +1% -5.83ms - +4.11ms	unsure 🔍 -1% - +1% -3.98ms - +6.00ms
tip-of-tree tip-of-tree	475.22ms - 482.60ms	unsure 🔍 -1% - +1% -4.11ms - +5.83ms	-	unsure 🔍 -1% - +1% -3.37ms - +7.11ms
previous-release previous-release	473.32ms - 480.76ms	unsure 🔍 -1% - +1% -6.00ms - +3.98ms	unsure 🔍 -1% - +1% -7.11ms - +3.37ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	481.99ms - 487.77ms	-	unsure 🔍 -1% - +1% -2.58ms - +4.82ms	unsure 🔍 -1% - +1% -2.65ms - +4.94ms
tip-of-tree tip-of-tree	481.46ms - 486.06ms	unsure 🔍 -1% - +1% -4.82ms - +2.58ms	-	unsure 🔍 -1% - +1% -3.34ms - +3.39ms
previous-release previous-release	481.28ms - 486.19ms	unsure 🔍 -1% - +1% -4.94ms - +2.65ms	unsure 🔍 -1% - +1% -3.39ms - +3.34ms	-

_{tachometer-reporter-action v2 for Benchmarks}

github-actions · 2025-05-22T01:53:04Z

The size of lit-html.js and lit-core.min.js are as expected.

augustjk

thanks!
made suggestions for adding mdn links to the respective observers for the @lit-labs/observer package, and a fix a target url for lit-element.

packages/labs/observers/README.md

packages/lit-element/README.md

Co-authored-by: Augustine Kim <[email protected]>

e111077 · 2025-05-22T05:34:04Z

packages/context/README.md

@@ -1,5 +1,17 @@
 # @lit/context

+Make data available to entire component subtrees with the context protocol


Optional: do we clarify what “THE context protocol” is elsewhere? Just to clarify it’s a community protocol and not just lit

Good point. I'll add "WCCG" and a link here.

e111077 · 2025-05-22T05:38:58Z

packages/lit-html/README.md

-Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
-
-Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
+When using `lit-html` to develop web components, most users should import lit-html via the [`lit`](https://www.npmjs.com/package/lit) package rather than installing and importing from `lit-html` directly.


Do we want non wc users to use this package or lit as well?

I think there are a few cases where you might want to install lit-html directly, but I don't know if we need to list them, which is why this says "most". (you could still be building web components, but without LitElement, for examples).

justinfagnani · 2025-05-22T16:51:17Z

Oops, I didn't realize that my git push had failed locally and I merged with a couple of hanging changes.

[all] A bunch of README updates

4900df2

Cleans up notices about old prereleases, adds badges and doc links, adds docs to observers.

justinfagnani requested review from augustjk, e111077 and sorvell May 22, 2025 01:50

justinfagnani requested a review from kevinpschaaf as a code owner May 22, 2025 01:50

Add changeset

ae4b09c

augustjk approved these changes May 22, 2025

View reviewed changes

Apply suggestions from code review

a0f91b9

Co-authored-by: Augustine Kim <[email protected]>

e111077 approved these changes May 22, 2025

View reviewed changes

justinfagnani merged commit aea85e2 into main May 22, 2025
10 checks passed

justinfagnani deleted the fix-readmes branch May 22, 2025 16:37

lit-robot mentioned this pull request Jul 11, 2025

Version Packages #5019

Merged

		@@ -1,5 +1,17 @@
		# @lit/context

		Make data available to entire component subtrees with the context protocol

[all] A bunch of README updates #4997

[all] A bunch of README updates #4997

Uh oh!

Conversation

justinfagnani commented May 22, 2025

Uh oh!

changeset-bot bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Tachometer Benchmark Results

Summary

nop-update

render

update

update-reflect

Results

render

update

update-reflect

render

update

nop-update

render

update

render

update

update-reflect

Uh oh!

github-actions bot commented May 22, 2025

Uh oh!

augustjk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

e111077 May 22, 2025

Choose a reason for hiding this comment

Uh oh!

justinfagnani May 22, 2025

Choose a reason for hiding this comment

Uh oh!

e111077 May 22, 2025

Choose a reason for hiding this comment

Uh oh!

justinfagnani May 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

justinfagnani commented May 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented May 22, 2025 •

edited

Loading

github-actions bot commented May 22, 2025 •

edited

Loading