Skip to content

docs(readme): say what the client does, not what it enables - #157

Merged
adnaan merged 1 commit into
mainfrom
voice
Aug 15, 2026
Merged

docs(readme): say what the client does, not what it enables#157
adnaan merged 1 commit into
mainfrom
voice

Conversation

@adnaan

@adnaan adnaan commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

This README mirrors to /client on the docs site, which now has a written voice — VOICE.md, added in livetemplate/docs#137.

The Overview opened with the product as subject and a verb standing in for the thing it actually does:

The LiveTemplate client enables reactive web applications by efficiently applying tree-based HTML updates from the server. It uses DOM morphing, intelligent static content caching, and WebSocket transport for real-time interactivity.

"enables reactive web applications" is not something the library does; applying updates to the DOM is. Now:

The server sends tree-based HTML updates; this client applies them to the DOM. It morphs the existing nodes rather than replacing them, keeps the static parts of the page cached, and carries actions and updates over a WebSocket.

Also ## How It Works## How it works, matching every other heading in the file.

Two lines total. No feature list, install steps, or API docs touched.

Verification

0 .ts/.js files touched. The repo's pre-commit hook ran lint, the full jest suite (824 passed, 39 suites) and the browser build — all green.

🤖 Generated with Claude Code

https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ

The Overview opened with "The LiveTemplate client enables reactive web
applications by efficiently applying tree-based HTML updates" — the product as
subject, and a verb ("enables") standing in for the thing it actually does.

The docs site mirrors this file to /client, which now has a written voice
(livetemplate/docs VOICE.md). This brings the opener in line with it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ
@claude

claude Bot commented Aug 15, 2026

Copy link
Copy Markdown

Reviewed — this is a clean, docs-only wording fix (2 lines, no code touched).

  • Overview rewrite is accurate: it correctly describes what the client does (applies tree updates via DOM morphing, static caching, WebSocket transport) rather than the vague "enables reactive web applications" framing.
  • ## How It Works## How it works is consistent — checked, every other heading in the file already uses sentence case.

No bugs, security issues, or quality concerns. LGTM.

@adnaan
adnaan merged commit 2c3978b into main Aug 15, 2026
7 checks passed
@adnaan
adnaan deleted the voice branch August 15, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant