Clean up keynote-2 template README & DEVELOP#4624
Open
bradleyshep wants to merge 4 commits intomasterfrom
Open
Clean up keynote-2 template README & DEVELOP#4624bradleyshep wants to merge 4 commits intomasterfrom
bradleyshep wants to merge 4 commits intomasterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Changes
Resolve contradictions between keynote-2 README and DEVELOP docs and align them with the codebase.
README.md:
pnpm installandpnpm run demoin Quick Demo (consistency with pnpm workspace)--concurrencyand--alphato demo options--separator todocker compose runbench exampleDEVELOP.md:
pnpm runthroughout (demo, prep, bench) instead ofnpm runsqlite→sqlite_rpc,postgres→postgres_rpc)--separator todocker compose runbench example; condense to single linenpm prep→pnpm run prepin Docker instructionsdemo.ts:
--concurrencydefault from 10 to 50 (matches docs and methodology)cli.ts:
.env.example:
USE_DOCKER=1andSKIP_CONVEX=1so demo defaults (convex, spacetimedb) work out of the boxCONVEX_USE_SHARDED_COUNTERAPI 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 && pnpm run demoin keynote-2 templatepnpm run bench test-1 --connectors spacetimedb,sqlite_rpc)docker compose run --rm bench -- --seconds 5 --concurrency 50 --connectors convex