Skip to content

Commit 6ea4041

Browse files
committed
docs: put each homepage step's details and link with its step
1 parent 870b9cc commit 6ea4041

2 files changed

Lines changed: 16 additions & 14 deletions

File tree

‎website/public/index.html‎

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -324,8 +324,9 @@ <h3>See what the tests missed</h3>
324324
<h3>Rename models without rebuilding history</h3>
325325
<p>
326326

327-
<code>sqb rename</code> and <code>sqb mv</code> update every reference and keep the existing table, so an incremental model doesn't start again. The old name keeps working as a view. Renamed columns keep their history too.
327+
<code>sqb rename</code> and <code>sqb mv</code> update every reference and keep the existing table, so an incremental model doesn't start again. The old name keeps working as a view. Renamed columns keep their history too. The old table is never modified during the migration.
328328
</p>
329+
<p class="more"><a href="/docs/concepts/models/migrations/">How migrations work →</a></p>
329330
</div>
330331
<pre class="terminal"><span class="cmd">sqb rename daily_activity_rollup daily_order_rollup</span>
331332
<span class="info strong">Rename model daily_activity_rollup -&gt; daily_order_rollup</span>
@@ -350,8 +351,9 @@ <h3>Rename models without rebuilding history</h3>
350351
<span class="num">08 · Tidy up safely</span>
351352
<h3>Archive old tables before deleting them</h3>
352353
<p>
353-
The janitor renames tables your project no longer builds, and only drops them once the archive expires, 14 days later by default.
354+
The janitor renames tables your project no longer builds, and only drops them once the archive expires, 14 days later by default. Until then an archive can be renamed back, and every move is recorded.
354355
</p>
356+
<p class="more"><a href="/docs/cli/janitor/">How the janitor works →</a></p>
355357
</div>
356358
<pre class="terminal"><span class="cmd">sqb janitor</span>
357359
<span class="info strong">Janitor preview</span> prod
@@ -368,8 +370,13 @@ <h3>Archive old tables before deleting them</h3>
368370
<span class="num">09 · Investigate</span>
369371
<h3>Find out what happened, then check what's true now</h3>
370372
<p>
371-
Every run is recorded: what ran, the SQL it executed, audit results and everything it printed. Agents and people ask in SQL, then check live state with the same command.
373+
SQLBuild records every run: what ran, the SQL it executed, audit results and everything it printed. You or an agent can query that history in SQL, and the same command queries the warehouse to check what's true now.
372374
</p>
375+
<p>
376+
Here an audit started warning on the latest run, but the build still exited 0. The first two commands show when it started and what the run printed. The third finds the cause, still in prod: a refund stored as a negative payment.
377+
</p>
378+
<p>History lives in a SQLite file in your project, or in ClickHouse for a team. No service to run, no account, no paid tier.</p>
379+
<p class="more"><a href="/docs/concepts/observability/recall/">How Recall works →</a></p>
373380
</div>
374381
<pre class="terminal"><span class="cmd">sqb recall query &quot;SELECT substr(a.invocation_started_at, 1, 16) AS run,
375382
a.outcome, a.violation_count, i.status, i.exit_code FROM audit_results a
@@ -391,17 +398,7 @@ <h3>Find out what happened, then check what's true now</h3>
391398
9 <span class="dim">|</span> 8 <span class="dim">|</span> <span class="warn">-2200</span> <span class="dim">|</span> 2026-04-03 15:42:00</pre>
392399
</div>
393400
</div>
394-
<p class="caption">
395-
Real output from SQLBuild's example project, trimmed to the relevant lines. During a migration the old
396-
table is never modified, archives can be renamed back until they expire, and every move is recorded.
397-
In step 09 the audit started warning on the latest run, the build still exited 0, and the cause
398-
is still in prod: a refund recorded as a negative payment. Three commands, no log digging.
399-
History stays in a SQLite file in your project, or in ClickHouse for a team. No service, no
400-
account, no paid tier.
401-
<a href="/docs/concepts/models/migrations/">How migrations work</a> ·
402-
<a href="/docs/cli/janitor/">How the janitor works</a> ·
403-
<a href="/docs/concepts/observability/recall/">How Recall works</a>
404-
</p>
401+
<p class="caption">Real output from SQLBuild's example project, trimmed to the relevant lines.</p>
405402
</div>
406403
</section>
407404

‎website/public/styles.css‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,11 @@ h3 {
440440
font-size: 15px;
441441
}
442442

443+
.step-text .more {
444+
margin-top: 14px;
445+
font-size: 14px;
446+
}
447+
443448
.terminal {
444449
margin: 0;
445450
padding: 22px 24px;

0 commit comments

Comments
 (0)