Repository navigation
docs: update local development setup documentation - #1059
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates developer-facing documentation to reflect the current local development workflow and add guidance for using Squad via OpenCode.
Changes:
- Adds a README section describing usage with OpenCode CLI.
- Adds README instructions for installing/running Squad from source, including global linking.
- Updates the docs-site contributing guide to use
npm run dev:link/npm run dev:unlinkand removes onebuild:clireference.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/src/content/docs/guide/contributing.md | Updates build/linking instructions to prefer npm run dev:link and removes build:cli from the primary build steps. |
| README.md | Adds OpenCode CLI usage guidance and a local-development installation section referencing dev:link. |
- Add "Local Development Installation" section to README with npm run dev:link instructions - Update CONTRIBUTING.md to use npm run dev:link for global linking - Remove references to non-existent npm run build:cli script - Simplify linking/unlinking instructions to use npm run dev:link/dev:unlink
anchapin
force-pushed
the
alex/local-dev-setup-fix
branch
from
May 1, 2026 21:01
97bfbe5 to
4658b03
Compare
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
Update local development setup documentation:
npm run dev:linkinstructionsnpm run dev:linkfor global linkingnpm run build:cliscriptnpm run dev:link/npm run dev:unlinkChanges
npm run dev:linkinstead of manualnpm linkcommandsTesting
Verified locally that
npm run dev:linkmakes thesquadcommand globally available and uses the local build.