Skip to content

Commit ff0a1d9

Browse files
committed
fix planning docs
Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
1 parent 6f4a2d8 commit ff0a1d9

4 files changed

Lines changed: 35 additions & 30 deletions

File tree

benchmarks-website/planning/00-overview.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ SPDX-FileCopyrightText: Copyright the Vortex contributors
88
## What we're building
99

1010
A replacement for the current `bench.vortex.dev` site. The new
11-
stack is a **single Rust binary** that owns a **DuckDB database**
12-
on local disk and serves the website plus an `/api/ingest` route.
13-
CI eventually POSTs new benchmark results there. There is no
14-
separate ingester service, no S3 coordination layer for writes, no
15-
client-side WASM.
11+
stack is a **single Rust binary** (axum + maud + duckdb-rs) that
12+
owns a **DuckDB database** on local disk and serves the website
13+
plus an `/api/ingest` route. CI eventually POSTs new benchmark
14+
results there. There is no separate ingester service, no S3
15+
coordination layer for writes, no client-side WASM.
1616

17-
HTTP framework, templating engine, and module layout are the
18-
server agent's call.
17+
The server crate is `vortex-bench-server` at
18+
`benchmarks-website/server/`.
1919

2020
## Phasing
2121

@@ -98,6 +98,7 @@ alpha; they come back in phase 2.
9898
## Status of v2 during alpha
9999

100100
v2 stays in production untouched. Do not edit
101-
`benchmarks-website/server.js` or `benchmarks-website/src/`. v3
102-
lives alongside under `benchmarks-website/` in a new Cargo crate
103-
(path is the server agent's call).
101+
`benchmarks-website/server.js`, `benchmarks-website/src/`, or any
102+
other v2 files at `benchmarks-website/` top level. v3 lives in the
103+
sibling subdirectory at `benchmarks-website/server/`
104+
(`vortex-bench-server` crate).

benchmarks-website/planning/AGENTS.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ detail belongs in component plans.
1111
## What you're working on
1212

1313
The **alpha** of v3 of `bench.vortex.dev`. Target: a single Rust
14-
binary with **DuckDB on local disk**. The smallest end-to-end loop
15-
that proves the design.
14+
binary (axum + maud + duckdb-rs) with **DuckDB on local disk**.
15+
The smallest end-to-end loop that proves the design.
1616

17-
The v2 site at `benchmarks-website/` is in production and stays
18-
running unchanged. v3 lives alongside in a new crate under
19-
`benchmarks-website/` (path is the server agent's call).
17+
The v2 site (top-level files in `benchmarks-website/`:
18+
`server.js`, `src/`, `package.json`, etc.) is in production and
19+
stays running unchanged. v3 lives alongside in
20+
`vortex-bench-server` at `benchmarks-website/server/`.
2021

2122
Anything not listed in [`README.md`](./README.md) under
2223
"Components" is **deferred**. See [`deferred.md`](./deferred.md).
@@ -43,8 +44,8 @@ You **don't** need to read other components' plans.
4344
See the root [`CLAUDE.md`](/CLAUDE.md) for Rust style, test layout,
4445
and CI norms. Project-specific:
4546

46-
- New crates go under `benchmarks-website/`. Add to root
47-
`Cargo.toml` workspace members.
47+
- The v3 server crate lives at `benchmarks-website/server/` and is
48+
registered in the root `Cargo.toml` `members` list.
4849
- All commits need a `Signed-off-by:` trailer.
4950
- Run `cargo +nightly fmt --all` and narrow clippy on what you
5051
changed.
@@ -70,10 +71,8 @@ and CI norms. Project-specific:
7071
| Branch | Purpose |
7172
|---|---|
7273
| `develop` | Live v2 site. Don't break. |
73-
| `claude/review-benchmarks-redesign-BO3la` | This planning branch. |
74-
| `claude/benchmarks-v3-<component>` | Per-workstream feature branches. |
75-
76-
Component branches start from `develop`.
74+
| `ct/benchmarks-v3` | Integration branch carrying the planning commit + landed component PRs. All component branches start here. |
75+
| `claude/benchmarks-v3-<component>` | Per-workstream feature branches, each branched from `ct/benchmarks-v3` and PR'd back to it. |
7776

7877
## How to update this file
7978

benchmarks-website/planning/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ worked on in parallel**.
4040
## Working branches
4141

4242
- `develop` - the v2 site, in production. **Do not touch.**
43-
- `claude/review-benchmarks-redesign-BO3la` - this planning branch.
44-
- Component branches above - one per workstream, branched from
45-
`develop`.
43+
- `ct/benchmarks-v3` - the integration branch carrying the
44+
planning commit and any landed component PRs. All component
45+
branches start here.
46+
- Component branches (one per workstream, see "Components" above),
47+
each branched from `ct/benchmarks-v3` and PR'd back to it.
4648

4749
## What this plan is not
4850

benchmarks-website/planning/decisions.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,18 @@ decisions deliberately stay open until we get there - see
7272
`/api/groups` as opaque strings and feeds them back unmodified
7373
into `/api/chart/:slug`. The server picks the slug format.
7474

75-
## Recommended (not pinned)
75+
## In use (locked in by the server PR)
7676

77-
These are starting points, not contracts. If the server agent has
78-
a stronger preference, change them.
77+
These were "recommended" before the server PR landed; they are now
78+
the actual stack in `benchmarks-website/server/Cargo.toml`. The
79+
web-ui agent inherits them by working in the same crate.
7980

8081
- HTTP framework: `axum`.
81-
- Compile-time HTML templates: `maud` (`askama` is fine).
82-
- DuckDB driver: `duckdb-rs`. Pin a version that supports
83-
`INSERT ... ON CONFLICT (...) DO UPDATE`.
82+
- Compile-time HTML templates: `maud`.
83+
- DuckDB driver: `duckdb-rs`, version pinned in the server crate's
84+
`Cargo.toml`.
85+
- Snapshot tests: `insta` (workspace dep).
86+
- Logging: `tracing` (workspace dep).
8487

8588
## Open
8689

0 commit comments

Comments
 (0)