René's URL Explorer Experiment

Title: Fix documentation examples and workflow notes to match implementation by Copilot · Pull Request #116 · bQuery/bQuery · GitHub

Open Graph Title: Fix documentation examples and workflow notes to match implementation by Copilot · Pull Request #116 · bQuery/bQuery

X Title: Fix documentation examples and workflow notes to match implementation by Copilot · Pull Request #116 · bQuery/bQuery

Description: Summary Correct documentation examples and workflow/tooling notes so they match the current bQuery APIs, SSR behavior, docs audit behavior, and latest review feedback on guide wording. Readers and contributors can copy/paste the examples without type errors and won’t be misled by inaccurate examples, cleanup guidance, or workflow comments. Motivation This change is needed because review feedback on PR #116 identified multiple documentation snippets and workflow notes that did not match the current implementation, including follow-up fixes for SSR streaming semantics, guide wording, and audit-script messaging. These fixes keep the docs aligned with the implementation so examples remain copy/paste-safe and tooling output is easier to interpret. Changes included docs/guide/ssr.md — update the streaming & caching section: flushBoundary() takes no arguments, createSSRCache({ ttlMs, maxEntries, getKey }), createSSRMetrics() is an imperative collector with snapshot(), createEdgeHandler(handler, options?) wraps a fetch-style handler; rewrite the example to combine createSSRContext, renderToResponse, and cache: { store, vary }; replace the { key } pitfall with guidance on cache.vary + createSSRCache({ getKey }); and clarify that flushBoundary() splits final output into chunks rather than providing true progressive async streaming. Also update the performance note to point readers to Suspense streaming for earlier TTFB. docs/workflows/streaming-ssr.md — fix flushBoundary() usage, cache option names (ttlMs/maxEntries), metrics description, server pipeline (createSSRContext({ request, metrics }) + renderToStream(template, data, { context }) for streaming; ctx.renderResponse with cache: { store, vary } for response caching), _metrics endpoint now reads metrics.snapshot(), edge variant now wraps a fetch-style handler, and pitfalls reference cache.vary / createSSRCache({ getKey }) instead of a non-existent { key } option. Also clarify that renderToStream() resolves the binding context up front, use a real HTML comment in the template example, align the workflow goal text with the actual metrics endpoint, and document that flush boundaries control chunk boundaries rather than time-to-first-byte. docs/workflows/off-main-thread.md — fix createReactiveTaskPool(handler, { concurrency, maxQueue }) signature, drop withTransferables' invalid second argument and the { html } wrapping, document the reactive signal mirrors (pending$, size$, state$, paused$, metrics$ with { completed, failed, avgRuntimeMs, p95RuntimeMs }), correct createSharedBuffer(byteLength) to take a number, remove the shared field from the HighlightInput call site, and update the summary bullets to reference numeric runOptions.priority and { concurrency, maxQueue }. docs/index.md — rewrite the “Two-minute example — server” snippet to use ctx.renderResponse(template, data) with an awaited app.listen(...). docs/concepts/rendering-modes.md — rewrite the SSR example to use ctx.renderResponse(template, data) with await app.listen(...); rewrite the Streaming SSR example to use a template string with flushBoundary() markers passed to ctx.renderStream(template, data); drop references to non-existent serveStatic / noHydrate options in the hydration section; and clarify that renderToStream() chunks the final HTML stream while renderToStreamSuspense() + defer() handle true progressive/out-of-order streaming. docs/workflows/todo-spa.md — fix the bq-for example so toggle/remove handlers use t.id instead of t.value.id. docs/cookbook/trace-signal.md — enable devtools in the recipe before calling trackSignal() so the example actually emits trace and timeline entries. scripts/check-doc-exports.mjs — keep fenced code contents in the doc corpus, correct the header comment so it no longer claims the default mode is used in CI, and update the final status messaging so informational/strict output accurately distinguishes a clean run from coverage gaps and audit errors. .github/workflows/docs-link-check.yml — clarify the workflow comment so it matches the actual informational fail: false behavior instead of implying link failures are blocking. docs/guide/server.md — fix the streaming example so ctx.stream() receives a ReadableStream and enqueues encoded byte chunks instead of strings. docs/workflows/index.md — correct the SSR hydration workflow summary to reference SSR plus runtime adapters instead of the @bquery/bquery/server module. docs/guide/store.md — replace a non-existent persist({ keys: [...] }) helper reference with accurate persisted-store/plugin guidance. docs/workflows/forms-validation.md — update the sign-up workflow to use the current forms API (initialValue, validator arrays, validationStrategy: 'onChange', handleSubmit(), per-field error signals, and form.errors signal reads) and reword locale-aware validation guidance so translations come from calling t() at validation time. docs/cookbook/login-form.md — update the login form recipe to use the current forms API (initialValue, validator arrays, minLength, validationStrategy: 'onChange', handleSubmit(), and field error signals). docs/guide/i18n.md — clarify that t() is reactive inside view bindings/effects because it reads the locale signal, while tc() is useful when a reusable computed translation signal is needed. docs/guide/view.md — correct cleanup guidance to use View.destroy() for mount() results, and fix testing guidance so mount() is imported from @bquery/bquery/view while screen, within(), fireEvent.*, and tick() come from @bquery/bquery/testing. Validation bun run lint bun run build bun test Additional focused checks (if applicable): bun run check:doc-exports; bun run docs:build; final review via parallel validation (Code Review clean, CodeQL clean/skipped on unchanged delta) Checklist I followed the contributing guidelines. I added or updated tests where behavior changed. I updated documentation when public behavior or developer workflow changed. I confirmed the change does not introduce security-sensitive regressions. Notes for reviewers The PR remains documentation/tooling focused; public runtime APIs are unchanged. The latest follow-up fixes also correct guide wording around i18n reactivity, view cleanup/testing imports, and SSR performance expectations. bun test still has a pre-existing unrelated failure in tests/motion.test.ts. scripts/check-doc-exports.mjs is still a soft, informational audit unless run with --strict; existing documentation coverage gaps remain informational and are not expanded by this PR.

Open Graph Description: Summary Correct documentation examples and workflow/tooling notes so they match the current bQuery APIs, SSR behavior, docs audit behavior, and latest review feedback on guide wording. Readers and...

X Description: Summary Correct documentation examples and workflow/tooling notes so they match the current bQuery APIs, SSR behavior, docs audit behavior, and latest review feedback on guide wording. Readers and...

Opengraph URL: https://github.com/bQuery/bQuery/pull/116

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width