Skip to content

Simplify the README - #2

Open
lxsmnsyc wants to merge 1 commit into
solidjs-community:mainfrom
lxsmnsyc:docs/simplify-readme
Open

Simplify the README#2
lxsmnsyc wants to merge 1 commit into
solidjs-community:mainfrom
lxsmnsyc:docs/simplify-readme

Conversation

@lxsmnsyc

@lxsmnsyc lxsmnsyc commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

The README carried a lot of prose that explained internals rather than usage. This trims it to what a reader needs, without dropping any documented API.

  • Remove every em-dash. Each one became a period and a new sentence, or a list item.
  • Turn multi-point paragraphs into lists. This covers what a target object accepts, what a component wrapped by Motion.create must do, and what the Playwright suite covers that jsdom cannot.
  • Cut the rationale that does not change what a reader writes. The reduced motion justification, the FLIP and projection detail, and the frame loop reasoning behind motion values are each one sentence now.
  • Fold the Introduction heading into a single line under the tagline.
  • Replace literary phrasing with plain wording.
  • Put the commands first in the Testing section and the port caveat last.
  • Document pnpm run storybook in Examples. Storybook came back with the last upstream sync but the section only mentioned the playground.

Word count drops from 4047 to 3412. All 25 headings still resolve and no anchor is broken.

The README carried a lot of prose that explained internals rather than
usage. This trims it to what a reader needs, without dropping any
documented API.

- Remove every em-dash. Each one became a period and a new sentence, or a
  list item.
- Turn multi-point paragraphs into lists. This covers what a target object
  accepts, what a component wrapped by `Motion.create` must do, and what the
  Playwright suite covers that jsdom cannot.
- Cut the rationale that does not change what a reader writes. The reduced
  motion justification, the FLIP and projection detail, and the frame loop
  reasoning behind motion values are each one sentence now.
- Fold the Introduction heading into a single line under the tagline.
- Replace literary phrasing with plain wording.
- Put the commands first in the Testing section and the port caveat last.
- Document `pnpm run storybook` in Examples. Storybook came back with the
  last upstream sync but the section only mentioned the playground.

Word count drops from 4047 to 3412. All 25 headings still resolve and no
anchor is broken.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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