Skip to content

Rewrite README for the Motion pakcage#216

Merged
ydaniv merged 14 commits into
masterfrom
interact-pkg-motion-readme
May 28, 2026
Merged

Rewrite README for the Motion pakcage#216
ydaniv merged 14 commits into
masterfrom
interact-pkg-motion-readme

Conversation

@ydaniv
Copy link
Copy Markdown
Collaborator

@ydaniv ydaniv commented May 20, 2026

No description provided.

Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md
Comment thread packages/motion/README.md
Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md Outdated
Comment thread packages/motion/README.md Outdated
@ameerf-wix ameerf-wix self-requested a review May 27, 2026 19:09
ameerf-wix
ameerf-wix previously approved these changes May 27, 2026
Copy link
Copy Markdown
Contributor

@ameerf-wix ameerf-wix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to remove my own block

Comment thread packages/motion/README.md
@ameerf-wix
Copy link
Copy Markdown
Contributor

Did several sessions with Claude with this PR and its plan in the context + #210 for context of already found discrepancies and future-plan of SSOT and made a few fixes to the README and the previously merged READMEs. The session amazingly converged quickly and there are now no discrepancy issues found in these READMEs anymore, or anything that seems missing. Only question left is whether to include all exported functions in the API table.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

Generated llms.txt preview

llms.txt
# @wix/interact

> Declarative, configuration-driven interaction library — web-native, AI-ready, and framework-agnostic.

- Install: `npm install @wix/interact @wix/motion-presets`
- Three entry points: vanilla JS (`@wix/interact`), React (`@wix/interact/react`), Web Components (`@wix/interact/web`)
- Five trigger types: hover, click, viewEnter, viewProgress, pointerMove
- Effects via named presets (`@wix/motion-presets`), keyframes, CSS transitions, or custom JS callbacks
- Configs are JSON-serializable -- designed for LLM generation

## Docs

- [Full Reference](https://wix.github.io/interact/rules/full-lean.md): Declarative configuration-driven interaction library. Binds animations to triggers via JSON config. (700 lines)
- [Integration Guide](https://wix.github.io/interact/rules/integration.md): Rules for integrating `@wix/interact` into a webpage — binding animations and effects to user-driven triggers via declarative configuration. (334 lines)

## Optional

- [Click Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/click.md): This document contains rules for generating click-triggered interactions in `@wix/interact`. (189 lines)
- [Hover Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/hover.md): This document contains rules for generating hover-triggered interactions in `@wix/interact`. (191 lines)
- [PointerMove Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/pointermove.md): These rules help generate pointer-driven interactions using `@wix/interact`. (279 lines)
- [ViewEnter Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/viewenter.md): This document contains rules for generating interactions that respond to elements entering the viewport using the `@wix/interact`. (226 lines)
- [ViewProgress Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/viewprogress.md): These rules help generate scroll-driven interactions using `@wix/interact`. (196 lines)
- [All rules in one file](https://wix.github.io/interact/llms-full.txt): Complete concatenation (2115 lines)
llms-full.txt header
# @wix/interact v2.3.0 -- AI Rules Reference
# https://wix.github.io/interact/llms.txt
# 7 files, 2115 lines

Download full files from workflow artifacts, or run node scripts/generate-llms.mjs locally.

Copy link
Copy Markdown
Collaborator Author

@ydaniv ydaniv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! Added some important comments

Comment thread packages/interact/README.md Outdated
Comment thread packages/motion/README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@ydaniv ydaniv merged commit a07f47b into master May 28, 2026
2 checks passed
@ydaniv ydaniv deleted the interact-pkg-motion-readme branch May 28, 2026 14:12
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.

2 participants