Commit 27c8029
docs: pre-release sweep — surface Phase 7 completion + MCP discoverability (#74)
Audit pass over docs/ + README + examples + SDK READMEs ahead of the
v0.1.25 release that ships sqlrite-mcp (Phase 7h) for the first time.
Phase 7 is now feature-complete except for the deferred FTS scope, so
a lot of "in progress" / "pending" / "shipping in 7g.X-7g.Y" wording
turned stale and needed flipping.
The biggest single gap was MCP discoverability — `sqlrite-mcp` was
only mentioned in its own README + a few cross-refs in the docs we
just shipped. Anyone landing on the root README, an SDK README, or
the Embedding doc would have no idea it existed. Added a one-liner
"sibling product" cross-ref everywhere.
## Changes
- **README.md** — flipped the Phase 7 "(in progress)" marker; added a
full "MCP server" section near the desktop install with
`cargo install sqlrite-mcp` + a Claude Code config snippet; rewrote
the "Per-product wrappers ship in 7g.3-7g.8" claim into past tense
with the MCP tool included; flipped the stale Phase 4 marker;
flipped "examples for every language" checkbox to done; dropped the
stale `0.1.0` REPL banner literal; rewrote the Phase 2 onboarding
hint about persistence ("`.open` coming in Phase 2" → present-day
"use `.open <path>`").
- **docs/_index.md** — refreshed the "Project state" with Phase 7
achievements (vector + HNSW, JSON, ask family, MCP); added MCP to
the published-artifacts list; flipped active frontier from "Phase 7"
to "Phase 8 (FTS)"; bumped May 2026.
- **docs/roadmap.md** — added an "Active frontier" callout at the
top; dropped "(in progress)" from Phase 3 and Phase 4 headings.
- **docs/phase-7-plan.md** — flipped status from "approved 2026-04-26
— implementation pending" to "complete except 7f, deferred to
Phase 8"; rewrote "Next steps" as a retrospective with pointers to
the two scope-correction retros (7d's HNSW split into three sub-
phases, 7g.2's dep-direction flip).
- **docs/embedding.md** — rewrote the Phase-5 status block (was
future tense across 5b-5g) into a retrospective; added 7g + 7h
bullets with the framing "use SDKs when YOUR code drives the DB,
use MCP when an LLM AGENT drives it"; rewrote the
"Per-product wrappers ship in 7g.3-7g.8" line.
- **docs/architecture.md** — added a Workspace layout table covering
every workspace member (sqlrite-engine root, sqlrite-ffi, sqlrite-
ask, sqlrite-mcp, the four SDKs, desktop) with what each does;
refreshed the engine module map to include connection.rs, ask/,
hnsw.rs, json.rs (all Phase 7 additions); rewrote the stale "What's
deliberately missing" section (transactions/locks/concurrency now
shipped — flipped to the actually-still-missing list: optimizer
beyond eq-probe, joins, aggregates, network layer, streaming
cursor).
- **docs/supported-sql.md** — added an HNSW indexes subsection under
CREATE INDEX with the `USING hnsw` syntax + the recall@10 ≥ 0.95
default + a note that brute-force still works without the index.
- **docs/smoke-test.md** — dropped the stale "123 tests pass" pin;
added a one-line smoke step for `cargo run --bin sqlrite-mcp -- --help`
to catch regressions in the stdio_redirect dance; updated the
"unsupported format version" note (3 → 4, since 7a bumped it);
dropped the `0.1.0` REPL banner literal.
- **docs/getting-started.md** — refreshed the repo-tree map to
include sqlrite-ffi/, sqlrite-ask/, sqlrite-mcp/, sdk/{python,
nodejs,go,wasm}/, examples/, scripts/, plus the new engine
modules (connection.rs, ask/, hnsw.rs, json.rs); dropped the
`0.1.0` REPL banner literal.
- **docs/usage.md** — flipped the future-tense "SDKs land in Phases
5b – 5g" to past tense; added MCP cross-ref.
- **docs/desktop.md** — rewrote the "see Roadmap Phase 5" cursor-
API line to point specifically at the deferred 5a.2.
- **sdk/{python,nodejs,go,wasm}/README.md** — added a "Sibling
products" subsection to each pointing at sqlrite-mcp with the
"your code vs LLM agent" framing.
- **sqlrite-ask/README.md** — NEW. The crate had no README, which
means the crates.io page would render only the Cargo.toml
description. Now: install snippet, "most users want the engine's
ask feature instead", configuration env-var table, features table,
architecture notes, sibling-products list. Cargo.toml gets the
matching `readme = "README.md"` field plus keywords + categories
for crates.io discoverability.
- **examples/README.md** — added an MCP row to the "Languages"
table pointing at docs/mcp.md (no examples/mcp/ subdir — the
doc covers the wiring directly, lower friction than maintaining
parallel quickstart files).
No code changes; no new tests. Existing test suite still passes
(workspace builds clean, `cargo test --workspace` minus the SDKs
that need their own runners shows ~340 tests passing across the
engine + sqlrite-mcp + sqlrite-ask + sqlrite-ffi).
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 860f843 commit 27c8029
18 files changed
Lines changed: 248 additions & 50 deletions
File tree
- docs
- examples
- sdk
- go
- nodejs
- python
- wasm
- sqlrite-ask
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
83 | 109 | | |
84 | 110 | | |
85 | 111 | | |
| |||
100 | 126 | | |
101 | 127 | | |
102 | 128 | | |
103 | | - | |
| 129 | + | |
104 | 130 | | |
105 | 131 | | |
106 | | - | |
| 132 | + | |
107 | 133 | | |
108 | 134 | | |
109 | 135 | | |
| |||
183 | 209 | | |
184 | 210 | | |
185 | 211 | | |
186 | | - | |
| 212 | + | |
187 | 213 | | |
188 | 214 | | |
189 | 215 | | |
| |||
230 | 256 | | |
231 | 257 | | |
232 | 258 | | |
233 | | - | |
| 259 | + | |
234 | 260 | | |
235 | 261 | | |
236 | 262 | | |
| |||
246 | 272 | | |
247 | 273 | | |
248 | 274 | | |
249 | | - | |
| 275 | + | |
250 | 276 | | |
251 | 277 | | |
252 | 278 | | |
| |||
265 | 291 | | |
266 | 292 | | |
267 | 293 | | |
268 | | - | |
| 294 | + | |
269 | 295 | | |
270 | 296 | | |
271 | 297 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | | - | |
| 45 | + | |
| 46 | + | |
46 | 47 | | |
47 | | - | |
| 48 | + | |
48 | 49 | | |
49 | 50 | | |
50 | 51 | | |
51 | 52 | | |
52 | 53 | | |
53 | | - | |
| 54 | + | |
54 | 55 | | |
55 | 56 | | |
56 | 57 | | |
57 | 58 | | |
58 | 59 | | |
59 | | - | |
60 | | - | |
| 60 | + | |
| 61 | + | |
61 | 62 | | |
62 | 63 | | |
63 | 64 | | |
| |||
0 commit comments