Skip to content

Clean up keynote-2 template README & DEVELOP#4624

Merged
clockwork-labs-bot merged 9 commits intomasterfrom
bradley/fix-template-readme-and-develop
Apr 17, 2026
Merged

Clean up keynote-2 template README & DEVELOP#4624
clockwork-labs-bot merged 9 commits intomasterfrom
bradley/fix-template-readme-and-develop

Conversation

@bradleyshep
Copy link
Copy Markdown
Contributor

@bradleyshep bradleyshep commented Mar 12, 2026

Description of Changes

Refresh this stale PR against current master. Several original items were already applied upstream or conflict with recent keynote-2 work (#4616, #4647, #4678, #4682, #4698, #4703, #4743, #4745, #4753, #4757), so those are dropped. What remains is the still-relevant subset, rebased onto the current file structures.

README.md:

  • Use pnpm run demo in Quick Demo (consistency with pnpm workspace)
  • Add --concurrency and --alpha to demo options
  • Add -- separator to docker compose run bench example
  • Fix hardware config punctuation (add comma before "OS:")
  • Remove redundant Quick Start section; replace with link to DEVELOP.md for prerequisites and CLI reference
  • Add symlink for license

DEVELOP.md:

  • Use pnpm run throughout (demo, prep, bench) instead of npm run
  • Drop the -- pass-through after pnpm run bench (not needed with pnpm; matches the #4703 testing examples)
  • Add Rust to Prerequisites
  • Add explicit list of valid connector names (convex, spacetimedb, bun, postgres_rpc, cockroach_rpc, sqlite_rpc, supabase_rpc, planetscale_pg_rpc)
  • Update CLI reference defaults to match methodology (seconds: 1→10, concurrency: 10→50)
  • Condense docker compose run bench example to a single line with -- separator; fix npm preppnpm run prep

src/opts.ts: (CLI parsing moved here in #4703; original PR targeted the now-gone inline parsers in cli.ts/demo.ts)

  • parseBenchOptions: bench --seconds default 110
  • parseDemoOptions: demo --concurrency default 1050

.env.example:

  • Comment out USE_DOCKER=1 and SKIP_CONVEX=1 so demo defaults (convex, spacetimedb) work out of the box
  • Comment out CONVEX_USE_SHARDED_COUNTER=1 (still a supported knob, just off by default)

Dropped as superseded by master

  • Rust Client README section tweaks (heading capitalization, bottlnecked/then typo fixes) — section was removed by #4753
  • Rename SPACETIME_METRICS_ENDPOINTUSE_SPACETIME_METRICS_ENDPOINT — master's src/config.ts still reads the original name
  • Connector-name fixes in examples (sqlitesqlite_rpc, postgrespostgres_rpc) — already corrected on master

API and ABI breaking changes

None.

Expected complexity level and risk

1 – Documentation and default-value changes. No functional changes to core logic.

Testing

  • pnpm install in templates/keynote-2/ succeeds
  • pnpm run bench --help / pnpm run demo --help render with valid-connec

@clockwork-labs-bot clockwork-labs-bot added this pull request to the merge queue Apr 16, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 16, 2026
@clockwork-labs-bot clockwork-labs-bot added this pull request to the merge queue Apr 17, 2026
Merged via the queue into master with commit 7143ed9 Apr 17, 2026
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants