Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .agents/docs/website.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The landing page should foreground performance and the engine's maturity rather

Taffy upstream describes the engine as high-performance and lists use by projects including Servo, Bevy, Slint and Zed, which supports the engine-level position. This evidence does not by itself prove the performance of a JavaScript binding. Before the website publishes numerical or comparative TaffyJS performance claims, retained end-to-end measurements must include the JavaScript-to-Rust boundary and JavaScript input and output conversion costs. The public measurement and presentation contract is recorded in [Benchmark Design](benchmark.md). See also the [Taffy repository](https://github.com/DioxusLabs/taffy) and [API alignment TODOs](api-alignment-todos.md).

The landing page speaks for TaffyJS as a family and presents the intended complete product rather than serving as a release-status page. It may describe the native and WebAssembly packages without labeling unfinished packages as planned; Guide and package documentation own concrete setup, runtime support, and public behavior.
The landing page speaks for TaffyJS as a family and presents the intended complete product rather than serving as a release-status page. It may describe native, WebAssembly, and Yoga-compatible packages without labeling unfinished packages as planned; Guide and package documentation own concrete setup, runtime support, and public behavior.

The home page is only a landing page and uses VitePress's default theme. It contains a concise performance-led introduction, short summaries of the Rust/Taffy foundation, native Node.js performance and portable WebAssembly support, and direct routes to real package documentation and source. Tutorials, complete examples, runtime details and API reference belong to Guide or package documentation rather than the home page. The home page does not use invented testimonials, unsupported benchmark numbers or generic feature text to fill space.
The home page is only a landing page and uses VitePress's default theme. It contains a concise performance-led introduction, feature summaries of native performance, WebAssembly support and Yoga compatibility, and direct routes to real package documentation and source. Those three features are the primary product messages: the Node package runs native Rust without mirroring layout state in JavaScript, the Wasm package carries the same JavaScript API into its supported environments, and the Yoga packages preserve Yoga's API shape for migration. Tutorials, complete examples, runtime details and API reference belong to Guide or package documentation rather than the home page. The home page does not use invented testimonials, unsupported benchmark numbers or generic feature text to fill space.

The landing page includes one code-to-layout example below the default Home content. It shows ordinary direct TaffyJS JavaScript rather than JSX or a second wrapper API, and the adjacent rectangles come from that exact source through `@taffyjs/wasm` and `getLayout`. Variable names label the corresponding boxes. Controls expose only inputs whose effects are immediately visible in those rectangles: available width, sidebar width, header height, and the horizontal and vertical gaps. The home page does not grow into an arbitrary code editor or a general-purpose playground.

Expand Down
10 changes: 5 additions & 5 deletions apps/website/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ hero:
text: GitHub
link: https://github.com/hyfdev/taffyjs
features:
- title: Powered by Rust
details: TaffyJS uses Taffy, a mature, high-performance Rust engine for Block, Flexbox, and Grid layout.
- title: Native performance
details: The Node.js package runs natively and avoids unnecessary work when passing data between JavaScript and Rust.
- title: Available everywhere
details: Use @taffyjs/wasm in browsers and other runtimes, with the same API as @taffyjs/node.
details: "@taffyjs/node runs Taffy as native Rust through Node-API. Tree operations update native state directly instead of maintaining a JavaScript copy."
- title: WebAssembly support
details: "@taffyjs/wasm runs the same JavaScript API in Node.js and bundled browsers when a native addon is not the right fit."
- title: Yoga compatibility
details: "Use @taffyjs/yoga or @taffyjs/yoga-wasm while preserving Yoga's API shape for a straightforward migration to TaffyJS."
---

<script setup>
Expand Down
Loading