docs: position compile() as the ergonomic-and-fast iteration path#88
Conversation
compile() now gives the readable `.each` body bindColumns-class speed while preserving reactivity, so it — not raw bindColumns — is the fast path most loops should reach for. Point readers at it from core-concepts (right after the .each example) and the README perf section, framing bindColumns as the further opt-in that drops reactivity for the last nanosecond. No fabricated numbers added to the curated README/_perf table snapshot — the `ecsia compile` row lands on the next clean `bench:report` regen.
Greptile SummaryDocs-only update that repositions
Confidence Score: 4/5Safe to merge after fixing the two minor formatting issues; no logic or behaviour changes. Both files are documentation only. The README link lands on the raw Markdown source instead of the rendered docs site, which is a small but real usability gap for readers who follow it. The missing blank line before the heading in core-concepts.md is a cosmetic Markdown formatting gap. Neither affects runtime behaviour. README.md — the Important Files Changed
Prompt To Fix All With AIFix the following 2 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 2
README.md:181
The `query.compile` link points to the raw GitHub source viewer (`github.com/.../blob/main/...`) rather than the deployed docs site used everywhere else in this file (e.g., `https://andymai.github.io/ecsia/guide/performance`). Readers will land on the Markdown source instead of the rendered documentation page.
```suggestion
[`query.compile`](https://andymai.github.io/ecsia/guide/performance#compile-the-ergonomic-path-compile)
```
### Issue 2 of 2
website/guide/core-concepts.md:114-115
The closing parenthesis of the new paragraph runs directly into the `### Deriving narrower queries` heading with no blank line. Most Markdown parsers require a blank line before ATX headings to render them correctly.
```suggestion
the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.)
### Deriving narrower queries
```
Reviews (1): Last reviewed commit: "docs: position compile() as the ergonomi..." | Re-trigger Greptile |
| strict CSP or sandbox forbids dynamic compilation). | ||
|
|
||
| You don't have to choose between the readable `.each` body and that speed: | ||
| [`query.compile`](https://github.com/andymai/ecsia/blob/main/website/guide/performance.md#compile-the-ergonomic-path-compile) |
There was a problem hiding this comment.
The
query.compile link points to the raw GitHub source viewer (github.com/.../blob/main/...) rather than the deployed docs site used everywhere else in this file (e.g., https://andymai.github.io/ecsia/guide/performance). Readers will land on the Markdown source instead of the rendered documentation page.
| [`query.compile`](https://github.com/andymai/ecsia/blob/main/website/guide/performance.md#compile-the-ergonomic-path-compile) | |
| [`query.compile`](https://andymai.github.io/ecsia/guide/performance#compile-the-ergonomic-path-compile) |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 181
Comment:
The `query.compile` link points to the raw GitHub source viewer (`github.com/.../blob/main/...`) rather than the deployed docs site used everywhere else in this file (e.g., `https://andymai.github.io/ecsia/guide/performance`). Readers will land on the Markdown source instead of the rendered documentation page.
```suggestion
[`query.compile`](https://andymai.github.io/ecsia/guide/performance#compile-the-ergonomic-path-compile)
```
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.) | ||
| ### Deriving narrower queries |
There was a problem hiding this comment.
The closing parenthesis of the new paragraph runs directly into the
### Deriving narrower queries heading with no blank line. Most Markdown parsers require a blank line before ATX headings to render them correctly.
| the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.) | |
| ### Deriving narrower queries | |
| the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.) | |
| ### Deriving narrower queries |
Prompt To Fix With AI
This is a comment left during a code review.
Path: website/guide/core-concepts.md
Line: 114-115
Comment:
The closing parenthesis of the new paragraph runs directly into the `### Deriving narrower queries` heading with no blank line. Most Markdown parsers require a blank line before ATX headings to render them correctly.
```suggestion
the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.)
### Deriving narrower queries
```
How can I resolve this? If you propose a fix, please make it concise.
What
Now that
compile()gives the readable.eachbodybindColumns-class speed and preserves reactivity, it's the fast path most loops should reach for — not rawbindColumns(which trades the reactivity bookkeeping for a raw-typed-array ceremony). This updates the guidance to match:.eachexample, point readers atcompile()(same body, ~6× faster, still feeds.changed()/observers, pure speedup with fallback).bindColumnsis reframed as the further opt-in for the last nanosecond.compile()as the way to keep the ergonomic body at near-eachChunkspeed.Notes
_perf-tables.mdsnapshot. Theecsia compiletable row (bucket + CI ratio lane already wired in feat: compile() — the ergonomic .each path, codegen'd to bindColumns speed #86) lands on the next cleanbench:reportregen — deliberately deferred off a loaded machine to avoid contaminating the published numbers, per the bench protocol.pnpm docs:checkpasses.