Repository navigation
docs: fix invalid devsy up command refs - #1017
Merged
Merged
Conversation
The sites/ docs referenced the non-existent top-level 'devsy up' command in six places across four files. The CLI root rejects 'devsy up' (unknown command 'up'); the correct command is 'devsy workspace up'.
✅ Deploy Preview for images-devsy-sh canceled.
|
✅ Deploy Preview for devsydev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Up to standards ✅🟢 Issues
|
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.
Doc area
sites/docs-devsy-sh/user docs — CLI command references in the developing-in-workspaces and how-it-works guides.Drift found
Six places across four docs used the non-existent top-level command
devsy up. The CLI root rejects it:The correct command is
devsy workspace up— confirmed by theupsubcommand registered undercmd/workspaceand the examples incmd/root.go. This includesdevsy up --from-snapshot <ref>, which the docs presented as a valid invocation.Correction
Replaced every bare
devsy upreference withdevsy workspace up:content/docs/how-it-works/deploying-workspaces.mdx—devsy up --from-snapshot <ref>→devsy workspace up --from-snapshot <ref>content/docs/how-it-works/overview.mdx—devsy up --from-snapshot→devsy workspace up --from-snapshotcontent/docs/developing-in-workspaces/continuous-integration.mdx—devsy up→devsy workspace upcontent/docs/developing-in-workspaces/workspace-snapshots.mdx— three references (devsy upin prose, thedevsy up --from-snapshot <ref>example, and the surrounding "restore as part ofdevsy up" line)No speculative additions; prose and surrounding structure unchanged.
Code verification performed
devsy upis rejected by the command tree:cmd/root.goresolves the top-level target viaresolveTarget, andupis not a top-level command (only theworkspaceparent command exposesup).devsy workspace upis the correct invocation (theupsubcommand undercmd/workspace, with examples incmd/root.go).--from-snapshotis a real flag ofdevsy workspace up(cmd/workspace/up_test.go:TestUpCmd_FromSnapshotSetsSource,TestUpCmd_FromSnapshotSetsDevContainerSource).grepoversites/confirms no remaining baredevsy upreferences after the change (only validdevsy workspace upforms remain).gh api repos/devsy-org/devsy/pulls).Verification gate
task cli:format— clean (docs-only change).task cli:lint:ci— 0 issues.task cli:test— passes except the known pre-existingpkg/gitTestRepoClone*failures, which fail onorigin/mainalready and are unrelated to this docs-only change (nopkg/orcmd/files touched).This PR was created by an AI agent as part of an automated daily docs job.