Skip to content

docs(troubleshooting): correct internal agent command path - #1704

Merged
skevetter merged 1 commit into
mainfrom
docs-cleanup/linux-troubleshooting-agent-path
Oct 25, 2026
Merged

skevetter merged 1 commit into
mainfrom
docs-cleanup/linux-troubleshooting-agent-path

Conversation

@skevetter

@skevetter skevetter commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Corrects the fish startup note in linux-troubleshooting.mdx to name devsy internal agent workspace up.
  • devsy agent ... is not a root command. The agent subcommand is registered only under the hidden internal parent.

Why

  • The page tells users which command their config.fish may interfere with. The named command does not exist in the CLI.
  • Code: cmd/internal/internal.go registers NewAgentCmd under internal; cmd/workspace/up/agent.go invokes internal agent workspace ....
  • Built CLI from origin/main 3e3b682: devsy internal agent workspace up --help works; devsy agent workspace up is unknown.

Fixes: none

Type of change

  • Docs

AI assistance

  • AI tools were used
    | Field | Answer |
    | --- | --- |
    | Tool and model | Paseo OMP with anthropic/claude-haiku-5-5; Codex GPT-6.1 Sol |
    | Used for | Audited command usage against source and corrected one docs command path |
    | Share of change | The one-line edit was drafted by the worker and verified against source and CLI help |
  • I read and understand every line of this change and can explain it in review.

Validation

  • npm ci and npm run check-links in sites/docs-devsy-sh: 0 errors.
  • npm run build in sites/docs-devsy-sh: exit 0.
  • Built CLI from origin/main and checked both command paths with --help.
  • No integration test needed because this is a docs-only edit; no executable behavior changed.

CodeRabbit CLI

  • Committed diff review against origin/main 3e3b682: completed, 0 findings, 1 file reviewed.

Auto-merge

Eligible: yes. Content-only, 1 changed line (1 added, 1 removed), one file, site build and link check green.

Next

  • devsy up also appears as stale docs text in workspace-snapshots.mdx; related error strings in pkg/devcontainer/config/snapshot.go and cmd/snapshot/create.go need a separate code PR.

The fish startup note named `devsy agent workspace up`, which is not a root command. The daemon invokes `devsy internal agent workspace ...` (pkg/client/clientimplementation/workspace_client.go); the `agent` parent is registered only under the hidden `internal` command (cmd/internal/internal.go).
@skevetter skevetter added the docs-cleanup Docs cleanup (maintenance bot) label Oct 25, 2026
@netlify

netlify Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 9b22e6e
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6ade4845d08c1e234ad3d2b6

@netlify

netlify Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit 9b22e6e
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6ade4845c5b47f8e0f2dd390
😎 Deploy Preview https://deploy-preview-1704--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.

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b18d0473-ffcb-4500-86a0-4503d83a658a
Commits

Reviewing files that changed from the base of the PR and between 3e3b682 and 9b22e6e.

Files selected for processing: 1
  • sites/docs-devsy-sh/content/docs/troubleshooting/linux-troubleshooting.mdx

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

The Linux troubleshooting guide now identifies devsy internal agent workspace up as the command that config.fish customizations may affect.

Changes: Fish startup guidance

Layer / File(s) Summary
Update the command reference
sites/docs-devsy-sh/content/docs/troubleshooting/linux-troubleshooting.mdx
The config.fish warning now names devsy internal agent workspace up instead of devsy agent workspace up.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: Minimal · up to 9b22e

No actionable merge-blocking risk remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title "docs(troubleshooting): correct internal agent command path" follows Conventional Commits form and names the change: the docs command path for the internal agent is corrected. The diff chang…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description check Passed The description explains the documentation change and rationale, identifies the issue as none, marks the change as documentation, records AI use, and documents validation. It does not reproduce the te…
Full details: Title check

Explanation

The title "docs(troubleshooting): correct internal agent command path" follows Conventional Commits form and names the change: the docs command path for the internal agent is corrected. The diff changes one line in linux-troubleshooting.mdx from devsy agent workspace up to devsy internal agent workspace up, so the title matches the main change.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description explains the documentation change and rationale, identifies the issue as none, marks the change as documentation, records AI use, and documents validation. It does not reproduce the template headings or checklist items, but it provides the relevant testing rationale for this docs-only change.

Finishing Touches
✨ Simplify code
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@skevetter
skevetter marked this pull request as ready for review October 25, 2026 18:39

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@mergify

mergify Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

@skevetter
skevetter merged commit 780b086 into main Oct 25, 2026
35 checks passed
@skevetter
skevetter deleted the docs-cleanup/linux-troubleshooting-agent-path branch October 25, 2026 18:43
@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Pull request is closed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-cleanup Docs cleanup (maintenance bot) size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant