Skip to content

Add package READMEs - #17

Merged
ntucker merged 1 commit into
mainfrom
docs/package-readmes
Aug 24, 2026
Merged

Add package READMEs#17
ntucker merged 1 commit into
mainfrom
docs/package-readmes

Conversation

@ntucker

@ntucker ntucker commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add installation and quick-start documentation for @reactive/silk
  • document the platform-neutral APIs and entry points in @reactive/silk-core
  • add React Native setup, theming, and component guidance for @reactive/silk-native

Verification

  • ran npm pack --dry-run for all three publishable packages
  • confirmed each package artifact includes its README
  • ran whitespace validation

Note

Low Risk
Documentation-only additions with no runtime, API, or security changes.

Overview
Adds npm-facing READMEs for @reactive/silk, @reactive/silk-core, and @reactive/silk-native with install, quick-start, theming, and entry-point guidance.

The web README covers SilkProvider, stylesheet options (styles.css vs styles.layer.css), and what the renderer includes. Core documents theme creation, recipes, and subpath exports. Native documents provider setup, shared semantic contracts, and the primitive set.

Reviewed by Cursor Bugbot for commit 4ae3133. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Aug 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4ae3133

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ntucker
ntucker merged commit 35fab8d into main Aug 24, 2026
3 checks passed
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