Skip to content

docs: improve React adapter package docs#26

Merged
aose-yuu merged 2 commits into
mainfrom
codex/improve-react-readme
May 23, 2026
Merged

docs: improve React adapter package docs#26
aose-yuu merged 2 commits into
mainfrom
codex/improve-react-readme

Conversation

@aose-yuu
Copy link
Copy Markdown
Contributor

@aose-yuu aose-yuu commented May 23, 2026

Purpose

Make the React adapter package easier to scan for first-time readers.

Summary

  • Starts the README with a small counter molecule before introducing props, deep signals, and controlled values.
  • Separates static props from live props getter usage and calls out the React dependency list requirement.
  • Moves the controller molecule dialog example into a dedicated controlled values section.
  • Adds the exported useSnapshot hook to the API reference.
  • Updates the npm package description to mention React hooks, molecules, and signals directly.

Verification

  • pnpm -s cicheck

@aose-yuu aose-yuu changed the title docs: improve React adapter README docs: improve React adapter package docs May 23, 2026
@aose-yuu aose-yuu merged commit 6716746 into main May 23, 2026
1 check passed
@aose-yuu aose-yuu deleted the codex/improve-react-readme branch May 23, 2026 05:51
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