Skip to content

docs: fix invalid devsy up command refs - #1017

Merged
skevetter merged 1 commit into
mainfrom
docs-keeper/fix-devsy-up-command
Aug 12, 2026
Merged

skevetter merged 1 commit into
mainfrom
docs-keeper/fix-devsy-up-command

Conversation

@devsy-app

@devsy-app devsy-app Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

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:

$ devsy up
Error: unknown command "up" for "devsy"

The correct command is devsy workspace up — confirmed by the up subcommand registered under cmd/workspace and the examples in cmd/root.go. This includes devsy up --from-snapshot <ref>, which the docs presented as a valid invocation.

Correction

Replaced every bare devsy up reference with devsy 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-snapshot
  • content/docs/developing-in-workspaces/continuous-integration.mdx — devsy up → devsy workspace up
  • content/docs/developing-in-workspaces/workspace-snapshots.mdx — three references (devsy up in prose, the devsy up --from-snapshot <ref> example, and the surrounding "restore as part of devsy up" line)

No speculative additions; prose and surrounding structure unchanged.

Code verification performed

  • Confirmed devsy up is rejected by the command tree: cmd/root.go resolves the top-level target via resolveTarget, and up is not a top-level command (only the workspace parent command exposes up).
  • Confirmed devsy workspace up is the correct invocation (the up subcommand under cmd/workspace, with examples in cmd/root.go).
  • Confirmed --from-snapshot is a real flag of devsy workspace up (cmd/workspace/up_test.go: TestUpCmd_FromSnapshotSetsSource, TestUpCmd_FromSnapshotSetsDevContainerSource).
  • grep over sites/ confirms no remaining bare devsy up references after the change (only valid devsy workspace up forms remain).
  • No duplicate open PR addresses this area (checked via 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-existing pkg/git TestRepoClone* failures, which fail on origin/main already and are unrelated to this docs-only change (no pkg/ or cmd/ files touched).

This PR was created by an AI agent as part of an automated daily docs job.

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'.
@netlify

netlify Bot commented Aug 12, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 545f6e7
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6a7c6d3d07697500073b7067

@netlify

netlify Bot commented Aug 12, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit 545f6e7
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6a7c6d3d782a340007c7d126
😎 Deploy Preview https://deploy-preview-1017--devsydev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: run a review on demand. To trigger the first review automatically, go to your organization or repository integration settings. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@skevetter
skevetter marked this pull request as ready for review August 12, 2026 14:32
@skevetter
skevetter merged commit 7f13e52 into main Aug 12, 2026
26 checks passed
@skevetter
skevetter deleted the docs-keeper/fix-devsy-up-command branch August 12, 2026 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant