Repository navigation
docs: clarify package fit and validate usage examples - #15
Merged
Merged
Conversation
Rewrites README usage guidance against the released package and adds a Context7 indexing config. Examples were checked once against the pinned release in a local fixture; no regression gate is committed.
melissa-lomray
added
the
documentation
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the missing orientation for this package: what it is (reusable pieces from our React Native apps, imported per subpath) and what it is not (a drop-in utility bundle — many modules need Firebase, Wix navigation or auth SDKs).
One fact worth calling out: the published 3.6.0 tarball has no root
index.js/index.d.tseven though the manifest names them, so a named import from the package root does not work. The README now says to import the specific subpath, and adds two small tagged examples (stores/switch-storeandhooks/use-keyboard-height) that were checked against the released package.Adds
context7.json(schema-validated, source/tests/example excluded).Verification: Tagged snippets passed a one-off semantic TypeScript check (skipLibCheck enabled) against the pinned released package in a local Node 20 fixture. Separate released-code probes used native and transport doubles where required. These do not establish real device or native compatibility. The local-only checker was removed because its fixture is not reproducible from committed files. No durable docs regression gate or workflow is added. Context7 configuration is not an index submission or refresh receipt.