Repository navigation
docs: rewrite the readme and add a manual - #4
Merged
Merged
Conversation
A mount animation with transition.when of beforeChildren or afterChildren made Solid warn that a reactive value was read outside a tracking scope.
A subtree or row with no exit leaves from a microtask. Reading the presence state there made Solid warn on every removal.
createMotionValue(0) returned a value typed as the literal 0, so it could only hold 0 and createVelocity rejected it.
Two tests spy on console.warn for the sequenced mount animation, and two for removing a subtree and a list row with no exit. One test calls createVelocity on a createMotionValue(0) result, which fails the typecheck without the fix.
A developer can now install and use the package from the readme, and find each part of the API on its own page with an example that was run. The manual is in docs/, one page per part of the API and a short architecture page. The development notes moved to .github/contributing.md.
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
1 participant
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.
The readme was one 600-line file mixing usage and internals. Running its examples exposed three defects, fixed here with tests.