From 316cc67d396f338681f7889e725263d2ae36b34e Mon Sep 17 00:00:00 2001 From: John Brecht Date: Sat, 13 Jun 2026 15:18:21 -0700 Subject: [PATCH] chore: fix shipped JSDoc doc link + doctor --setup progress line From umami's 0.10.0 dogfood: - The settleUntil JSDoc (which ships in dist/types.d.ts) pointed at "docs/writing-tutorials.md", a path not in the published package. Point it at the hosted docs URL so the reference resolves from an installed package. - doctor --setup now prints a progress line before running the probe, so the failure path (bounded by the adapter's own waitForURL timeout) reads as work in progress rather than a hang. Co-Authored-By: Claude Opus 4.8 (1M context) --- packages/cli/src/doctor.ts | 4 ++++ packages/core/src/types.ts | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/packages/cli/src/doctor.ts b/packages/cli/src/doctor.ts index ad310c3..010633d 100644 --- a/packages/cli/src/doctor.ts +++ b/packages/cli/src/doctor.ts @@ -103,6 +103,10 @@ export async function doctorCommand(opts: { config?: string; setup?: boolean } = // seeds + signs in for real (#19). if (opts.setup) { if (config) { + // Progress line: the probe runs the adapter's real setup, so it's bounded + // by the adapter's own waits (e.g. a 30s waitForURL on sign-in) and can + // take a while on the failure path — say so rather than looking hung. + console.log('… running adapter.setup (bounded by your adapter\'s own timeouts)'); try { await probeAdapterSetup(config.adapter); checks.push({ name: 'adapter.setup', ok: true, detail: 'ran and tore down cleanly' }); diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts index 3dedf56..539ea0b 100644 --- a/packages/core/src/types.ts +++ b/packages/core/src/types.ts @@ -70,7 +70,8 @@ export interface Step { * `startTransition`-deferred Server Action dispatches its request, settling on * the pre-mutation UI. For the standard `startTransition` + Server Action + * `router.refresh()` pattern, prefer `waitFor` on the committed UI (the value - * flipping, a toast appearing) — see docs/writing-tutorials.md "Settling". + * flipping, a toast appearing) — see the "Settling" guide: + * https://github.com/jbrecht/tutorial-forge/blob/main/docs/writing-tutorials.md#settling-waitfor-vs-settleuntil-vs-settlems */ settleUntil?: 'load' | 'domcontentloaded' | 'networkidle'; /** Extra hold time (ms) after both narration and action complete. Default 400. */