Skip to content

docs: improve use package docs#203

Merged
aose-yuu merged 2 commits into
mainfrom
codex/improve-use-package-docs
May 24, 2026
Merged

docs: improve use package docs#203
aose-yuu merged 2 commits into
mainfrom
codex/improve-use-package-docs

Conversation

@aose-yuu

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

Copy link
Copy Markdown
Contributor

Purpose

Make the use package metadata and docs match the current Sigrea API and remain readable from npm.

Summary

  • Clarifies the package description and keywords around framework-agnostic Sigrea utilities.
  • Restores and links the @sigrea/core relationship in the README.
  • Replaces npm-broken relative documentation links with GitHub URLs.
  • Updates the createEvents molecule example to use props parameter typing so return types stay inferred.
  • Wraps long README prose around sentence and clause boundaries.

Verification

  • pnpm -s cicheck

@aose-yuu aose-yuu merged commit 0e9ec76 into main May 24, 2026
1 check passed
@aose-yuu aose-yuu deleted the codex/improve-use-package-docs branch May 24, 2026 02:59
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