Skip to content

docs: improve core package docs#60

Merged
aose-yuu merged 1 commit into
mainfrom
codex/improve-core-package-docs
May 23, 2026
Merged

docs: improve core package docs#60
aose-yuu merged 1 commit into
mainfrom
codex/improve-core-package-docs

Conversation

@aose-yuu

Copy link
Copy Markdown
Contributor

Purpose

Make the core package metadata and README easier to scan for first-time readers.

Summary

  • Clarifies the package description and keywords around reactive primitives, deep signals, scopes, and molecule lifecycles.
  • Fixes README code examples to rely on props parameter typing so molecule return types stay inferred.
  • Points the README mascot image at a GitHub raw URL so it still renders from the npm package README.
  • Tightens wording around plain helpers, tracked molecule cleanup, and examples that use @sigrea/use.

Verification

  • pnpm -s cicheck
  • Sub-agent review: remaining must-fix findings none

@aose-yuu aose-yuu merged commit abd91d4 into main May 23, 2026
1 check passed
@aose-yuu aose-yuu deleted the codex/improve-core-package-docs branch May 23, 2026 06:36
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