Skip to content

docs: correct provider and workspace guidance - #1757

Merged
skevetter merged 1 commit into
mainfrom
docs/1749-apply-coderabbit-review-fixes
Nov 3, 2026
Merged

skevetter merged 1 commit into
mainfrom
docs/1749-apply-coderabbit-review-fixes

Conversation

@skevetter

@skevetter skevetter commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Cause

Merged documentation gave incorrect guidance on provider options, workspace lifecycle, and setup.

Fix

Corrected provider recovery and secret handling, workspace retention and credential forwarding, snapshots, CI suite selection, and platform tutorials. Removed an obsolete manifest header.

Test evidence

Commit: 1d1928e

  • npm run build in sites/docs-devsy-sh: passed.
  • npm run check-links in sites/docs-devsy-sh: 0 errored files, 0 errors.
  • mise exec -- go test ./hack/ci: 1 package passed, 0 failed.
  • mise run cli:lint:ci: 0 issues.
  • Exported credentials page rendered and inspected in the browser.
  • CI run 41668723978, attempt 4: 95 of 95 jobs passed, including CI Success.
  • Greptile: 5/5, no actionable issues. CodeRabbit: no actionable comments.

Not verified

Live provider behavior and deployed docs.

@netlify

netlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit 1d1928e
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6aea03bde6ac6aae71a37783
😎 Deploy Preview https://deploy-preview-1757--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 Nov 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

This pull request revises provider, CI, workspace, and setup documentation. It updates guidance about provider options and removal, test-tier labels, workspace lifecycle and retention, and provider setup steps. It also removes introductory comments from the CI test-tier manifest.

Changes: Documentation updates

Layer / File(s) Summary
Provider configuration and discovery guidance
.agents/skills/devsy/references/providers.md, CONTRIBUTING.md
Provider guidance now describes environment variables for sensitive options, authorization for provider removal or replacement, and the source of additional Desktop wizard providers.
CI test-tier guidance
hack/ci/README.md, hack/ci/suites.yaml
The Ginkgo guidance expands the labels excluded from direct PR CI selection. Introductory comments are removed from the test-tier manifest.
Workspace behavior and lifecycle guidance
sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx, sites/docs-devsy-sh/content/docs/developing-in-workspaces/create-a-workspace.mdx, sites/docs-devsy-sh/content/docs/developing-in-workspaces/credentials.mdx, sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx, sites/docs-devsy-sh/content/docs/developing-in-workspaces/inactivity-timeout.mdx, sites/docs-devsy-sh/content/docs/developing-in-workspaces/stop-and-delete-a-workspace.mdx, sites/docs-devsy-sh/content/docs/developing-in-workspaces/workspace-snapshots.mdx
The documentation is updated for CI runs, ignore rules, credential tunnels, container rebuilds, inactivity timeouts, workspace data retention, and snapshots.
Provider setup and resource guidance
sites/docs-devsy-sh/content/docs/fragments/setup-virtualbox.mdx, sites/docs-devsy-sh/content/docs/tutorials/minikube-vscode-browser.mdx, sites/docs-devsy-sh/content/docs/tutorials/podman-provider-setup.mdx
Tutorial guidance now uses a printed kubeconfig path and a named Podman machine. The VirtualBox walkthrough presents resource values as recommendations.

Estimated code review effort: 2 (Simple) | ~15 minutes

Change: Other

Possibly related PRs

  • devsy-org/devsy#1749: Updates overlapping provider, workspace, CI, credentials, timeout, snapshot, and tutorial documentation.
  • devsy-org/devsy#1740: Changes CLI help for devsy ci workspace cleanup, which this pull request also documents.
  • devsy-org/devsy#1683: Documents provider-specific workspace teardown and deletion handling, related to this pull request’s workspace deletion guidance.
Merge Risk: Minimal · up to 1d192

The documentation corrections present no identified merge-blocking risk. The change is ready to merge subject to normal checks.

Pre-merge checks: Passed 3 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description has a clear Cause and Fix, lists test evidence with a commit reference, and records what was not verified. It does not follow the repository template. The Type of change, AI assistance… Rewrite the description to follow the repository template. Add a Type of change selection (Docs, and CI / build / tooling for the hack/ci edits). Complete the AI assistance section and state whether AI tools were used. Complete the Testing …
Passed Passed checks: 3 passed
Check name Status Explanation
Title check Passed The title clearly identifies the main change: correcting provider and workspace documentation guidance.
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.
Full details: Description check

Explanation

The description has a clear Cause and Fix, lists test evidence with a commit reference, and records what was not verified. It does not follow the repository template. The Type of change, AI assistance, Testing (integration/e2e checkbox and suite selection), and Checklist sections are missing. The title is not stated, and the What and why section is not labeled as such. The changes are documentation and a CI-tooling README/manifest edit, so no e2e integration test is strictly required, but the template's 'No integration test needed, because:' line and the AI assistance disclosure are absent.

Resolution

Rewrite the description to follow the repository template. Add a Type of change selection (Docs, and CI / build / tooling for the hack/ci edits). Complete the AI assistance section and state whether AI tools were used. Complete the Testing section with the 'No integration test needed, because:' line and name the reason, such as docs only and CI only. Add a 'Fixes #' or 'Refs #' line, or write 'none'. Complete the Checklist, including the mise run cli:lint:ci and cli:test items, the docs-updated item, and the no-secrets item. Remove unused template sections and any placeholders. Confirm the CLA is signed.

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
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: 5f58d354-4d98-4418-be1e-149d952cf731
Commits

Reviewing files that changed from the base of the PR and between 161bc10 and 1d1928e.

Files selected for processing: 14
  • .agents/skills/devsy/references/providers.md
  • CONTRIBUTING.md
  • hack/ci/README.md
  • hack/ci/suites.yaml
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/create-a-workspace.mdx
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/credentials.mdx
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/inactivity-timeout.mdx
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/stop-and-delete-a-workspace.mdx
  • sites/docs-devsy-sh/content/docs/developing-in-workspaces/workspace-snapshots.mdx
  • sites/docs-devsy-sh/content/docs/fragments/setup-virtualbox.mdx
  • sites/docs-devsy-sh/content/docs/tutorials/minikube-vscode-browser.mdx
  • sites/docs-devsy-sh/content/docs/tutorials/podman-provider-setup.mdx

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

@netlify

netlify Bot commented Nov 3, 2026

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 1d1928e
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6aea03bd96336a747b9098fe

@skevetter

Copy link
Copy Markdown
Contributor Author

@greptileai review

@greptile-apps

greptile-apps Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The documentation changes appear safe to merge.

Summary

Corrects provider setup and recovery guidance, workspace data lifetime, credential forwarding, and snapshots.

  • Provider setup guidance keeps sensitive options out of command lines.
  • The Desktop provider wizard gets extra choices from named repositories.
  • devsy ci cleans up new workspaces but leaves existing ones alone.
  • Recreate guidance explains when the old container stays and how recovery works.
  • Credential guidance explains how browser tunnels keep their GitHub settings.
  • Workspace guidance names the provider and local-history exceptions to data removal.
  • Snapshot guidance explains which parts stay local and which need a registry.
  • Timeout guidance ties monitoring to a positive effective timeout.
  • Workspace upload guidance explains why ignore rules cannot restore cloned files.
  • CI guidance explains which test labels PR workflows must not select directly.
  • The VirtualBox walkthrough labels its resource figures as recommendations.
  • The Kubernetes tutorial shows how to find the local kubeconfig path.
  • Podman troubleshooting names the machine to start.

No actionable issues were found. This review checked source code; it did not run builds, tests, or live providers.

Reviews (1) · Last reviewed commit: "docs: correct provider and workspace gui..." · Reviewed by Greptile

@skevetter
skevetter marked this pull request as ready for review November 3, 2026 20:20
@skevetter

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@mergify

mergify Bot commented Nov 3, 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.

@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Action not completed

Review rate limited.


Your included review limit is currently reached under our Fair Usage Limits Policy. This review may still proceed through usage-based billing if eligible. Your next included review will be available in 7 minutes.

@skevetter
skevetter merged commit 848c7b9 into main Nov 3, 2026
170 of 177 checks passed
@skevetter
skevetter deleted the docs/1749-apply-coderabbit-review-fixes branch November 3, 2026 20:28
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