Fix a few inconsistencies in the documentation (#7)

Author: habedi

README.md

@@ -9,7 +9,7 @@
 [![Zig Version](https://img.shields.io/badge/Zig-0.15.2-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
 [![Release](https://img.shields.io/github/release/CogitatorTech/vizier.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/vizier/releases/latest)
 
-A database advisor and finetuner for DuckDB
+A physical design advisor for DuckDB
 
 </div>
 
@@ -28,8 +28,8 @@ When you have a DuckDB database, you are typically on your own to figure out thi
 
 There are tools like [pg_qualstats](https://github.com/powa-team/pg_qualstats) (for PostgreSQL) and
 [Database Engine Tuning Advisor](https://learn.microsoft.com/en-us/sql/relational-databases/performance/database-engine-tuning-advisor?view=sql-server-ver17)
-(for SQL Server) that try to solve these problems, but nothing equivalent exists for DuckDB.
-Vizier aims to fill that gap.
+(for SQL Server) that try to solve these kinds of problems, but nothing equivalent exists for DuckDB.
+Vizier is a step towards filling that gap.
 
 ### Features
 

ROADMAP.md

@@ -103,7 +103,7 @@ This document outlines the features implemented in Vizier and the future goals f
 - [x] SQL-based benchmarks against real-world datasets (`benches/` and `make bench`)
 - [x] TPC-H correctness validation (`benches/tpch_correctness.sql`)
 - [x] Cross-platform build support (Linux, macOS, Windows, and FreeBSD)
-- [x] CI pipeline with 9-platform cross-compile
+- [x] CI pipeline with 8-platform cross-compile
 - [x] Schema migration support for upgrades (`ALTER TABLE ADD COLUMN IF NOT EXISTS`)
 - [x] Cross-version state load/save compatibility (`INSERT BY NAME`)
 
@@ -115,7 +115,7 @@ to accumulate over days and weeks.
 - [x] `vizier_init(path)` persistent state file initialization
 - [x] Autoload state on extension init if `state_path` setting is configured
 - [x] Auto-save metadata tables on `vizier_flush()` when `state_path` is configured
-- [x] `vizier_export(path)` and `vizier_import(path)` for state transfer across environments
+- [x] `vizier_save(path)` and `vizier_load(path)` for state transfer across environments
 - [ ] Attach-based persistence using `ATTACH ':vizier_state:' AS vizier` to a file-backed database
 
 ### Automatic Query Capture

docs/index.md

@@ -1,6 +1,6 @@
 # Vizier
 
-**A database advisor and finetuner for DuckDB.**
+**A physical design advisor for DuckDB.**
 
 ---
 
@@ -18,8 +18,8 @@ When you have a DuckDB database, you are typically on your own to figure out thi
 
 There are tools like [pg_qualstats](https://github.com/powa-team/pg_qualstats) (for PostgreSQL) and
 [Database Engine Tuning Advisor](https://learn.microsoft.com/en-us/sql/relational-databases/performance/database-engine-tuning-advisor?view=sql-server-ver17)
-(for SQL Server) that try to solve these problems, but nothing equivalent exists for DuckDB.
-Vizier aims to fill that gap.
+(for SQL Server) that try to solve these kinds of problems, but nothing equivalent exists for DuckDB.
+Vizier is a step towards filling that gap.
 
 ## How It Works?
 
@@ -46,6 +46,23 @@ select * from vizier_apply(1);
 select * from vizier_benchmark('select * from events where account_id = 42', 10);
 ```
 
+## When to Use Vizier?
+
+Vizier is most useful for:
+
+- Analyzing your query patterns and recommends the sort order and partitioning strategy for Parquet exports. Getting the
+  sort order wrong means 10-100x worse row-group pruning.
+- Optimizing persistent DuckDB tables. If you have tables that get scanned repeatedly with the same filter patterns, Vizier identifies which columns
+  to sort by for scan pruning.
+- Understanding workload patterns. `vizier.workload_summary`, `vizier.inspect_table()`, and `vizier.overview()` give you a quick picture of which
+  tables and columns are under the most pressure. This can be useful when inheriting a database you did not build.
+
+Vizier is less useful for:
+
+- Ad-hoc notebook analysis (no repeating patterns).
+- Tiny datasets (DuckDB is already fast).
+- Read-only Parquet scans like reading Parquet files on an S3 bucket.
+
 ## What Vizier Is Not
 
 Vizier is not an auto-tuner.

src/vizier/dashboard.zig

@@ -70,7 +70,7 @@ pub const template_before: [*:0]const u8 =
     \\  <div id="replay" class="tab"></div>
     \\  <div id="overview" class="tab"></div>
     \\</div>
-    \\<footer>Generated by Vizier — physical design advisor for DuckDB</footer>
+    \\<footer>Generated by Vizier</footer>
     \\<script>
     \\const D=
 ;