Skip to content

docs: position compile() as the ergonomic-and-fast iteration path#88

Merged
andymai merged 1 commit into
mainfrom
docs/compile-positioning
Jun 8, 2026
Merged

docs: position compile() as the ergonomic-and-fast iteration path#88
andymai merged 1 commit into
mainfrom
docs/compile-positioning

Conversation

@andymai
Copy link
Copy Markdown
Owner

@andymai andymai commented Jun 8, 2026

What

Now that compile() gives the readable .each body bindColumns-class speed and preserves reactivity, it's the fast path most loops should reach for — not raw bindColumns (which trades the reactivity bookkeeping for a raw-typed-array ceremony). This updates the guidance to match:

  • core-concepts.md — right after the .each example, point readers at compile() (same body, ~6× faster, still feeds .changed()/observers, pure speedup with fallback). bindColumns is reframed as the further opt-in for the last nanosecond.
  • README.md — perf section prose now mentions compile() as the way to keep the ergonomic body at near-eachChunk speed.

Notes

  • No fabricated numbers added to the curated README/_perf-tables.md snapshot. The ecsia compile table row (bucket + CI ratio lane already wired in feat: compile() — the ergonomic .each path, codegen'd to bindColumns speed #86) lands on the next clean bench:report regen — deliberately deferred off a loaded machine to avoid contaminating the published numbers, per the bench protocol.
  • Docs-only; pnpm docs:check passes.

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.
@andymai andymai enabled auto-merge (squash) June 8, 2026 10:01
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Jun 8, 2026

Greptile Summary

Docs-only update that repositions compile() as the primary ergonomic-and-fast iteration path in both README.md and core-concepts.md, demoting bindColumns to a last-nanosecond opt-in for raw typed-array loops.

  • README.md: Inserts a paragraph after the perf table prose explaining that query.compile gives .each-style bodies near-eachChunk speed while preserving reactivity, with a link to the performance page (currently pointing at the GitHub blob URL rather than the deployed docs site).
  • core-concepts.md: Replaces the old one-liner bindColumns callout with a fuller compile() description and parenthetical bindColumns note; the closing paragraph runs directly into the next ### heading without a blank line.

Confidence Score: 4/5

Safe 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 query.compile link should point to the deployed docs site, not the GitHub blob viewer.

Important Files Changed

Filename Overview
README.md Adds a paragraph positioning query.compile as the ergonomic fast path; the new link uses a GitHub source URL instead of the deployed docs site URL used consistently elsewhere in the file.
website/guide/core-concepts.md Rewrites the post-.each performance callout to lead with compile() and demote bindColumns; missing blank line before the following ### heading may break rendering in strict parsers.

Fix All in Claude Code

Prompt To Fix All With AI
Fix 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

Comment thread README.md
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)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 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.

Suggested change
[`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!

Fix in Claude Code

Comment on lines +114 to 115
the reactivity bookkeeping too — the [performance page](/guide/performance) covers both.)
### Deriving narrower queries
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 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.

Suggested change
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.

Fix in Claude Code

@andymai andymai merged commit 1fbc38f into main Jun 8, 2026
15 of 16 checks passed
@andymai andymai deleted the docs/compile-positioning branch June 8, 2026 10:17
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.

1 participant