docs: add guide for testing local CLI changes outside the monorepo - #137
Merged
Conversation
miguel-heygen
force-pushed
the
docs/testing-local-cli
branch
from
March 30, 2026 16:57
81c3ebb to
bdb2332
Compare
vanceingalls
approved these changes
Mar 30, 2026
jrusso1020
reviewed
Mar 30, 2026
miguel-heygen
force-pushed
the
docs/testing-local-cli
branch
from
March 30, 2026 20:06
bdb2332 to
b125750
Compare
miguel-heygen
force-pushed
the
fix/studio-bugs
branch
from
March 30, 2026 20:25
7e4426b to
3fa61e1
Compare
jrusso1020
approved these changes
Mar 30, 2026
miguel-heygen
force-pushed
the
docs/testing-local-cli
branch
4 times, most recently
from
March 30, 2026 22:03
38a4771 to
dfc9420
Compare
Covers pnpm link, node alias, and npm pack workflows with a table of test scenarios for each bug fix category.
Addresses review feedback: move the local CLI testing guide out of the Guides nav group and into the Contributing section alongside contributing.mdx.
miguel-heygen
force-pushed
the
docs/testing-local-cli
branch
from
March 30, 2026 22:06
dfc9420 to
f098a71
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
3 participants
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
Adds
docs/guides/testing-local-changes.mdx— a contributor guide explaining how to test unreleased CLI changes against real projects outside the monorepo.Covers:
pnpm link --global(recommended — makeshyperframesin$PATHpoint at your local build)nodealias (no PATH changes)npm pack(test the exact artifact that would be published)which hyperframes, port conflicts, stale builds)Also registers the page in
docs/docs.jsonso it appears in the Guides nav.