📖 docs: add missing build step to quick start#70
Open
tenlisboa wants to merge 1 commit intowarengonzaga:devfrom
Open
📖 docs: add missing build step to quick start#70tenlisboa wants to merge 1 commit intowarengonzaga:devfrom
tenlisboa wants to merge 1 commit intowarengonzaga:devfrom
Conversation
README's quick start went bun install -> bun start, but bun start runs bun dist/index.js and dist/ does not exist after a fresh install, so the first run fails with "Module not found dist/index.js". Insert a bun run build step between install and start.
|
|
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.
Summary
The README's Quick Start skips straight from
bun installtobun start, butbun startresolves tobun dist/index.js(viasrc/cli/package.json) anddist/does not exist after a fresh install. A first-time follower of the docs hits:This PR inserts a Build step between Install and Run so the documented flow actually works end to end.
Reproduction
After the fix:
Notes for reviewer
devper CONTRIBUTING.md.bun startalone prints CLI usage rather than openinghttp://localhost:3000; reaching the web UI seems to needtinyclaw setup --web/tinyclaw start. Happy to follow up in a second PR if you confirm the intended first-run flow.Checklist
dev📖 docs: …)