docs: update doc content#742
Merged
Merged
Conversation
Correctness fixes verified against the codebase:
- devcontainer-json: remove stale 'Unsupported Properties' warning —
userEnvProbe, waitFor, and parallel lifecycle scripts are all now
supported (config fields, --user-env-probe flag, e2e coverage,
parallel hook execution in lifecyclehooks.go)
- update: Desktop update check is every ~few hours (RECHECK_INTERVAL_MS
= 6h), not 15 minutes; drop the dangling missing-screenshot reference
and merge the two Desktop headings
- credentials: fix broken sentence ('you must that via')
- add-provider: fix comma splice and broken 'Else, to can manage' line
Editorial (voice alignment, no adverbs):
- what-are-providers: tighten older-tone prose, drop 'simple'/filler
- what-are-workspaces: remove 'actually'
- add-provider: collapse duplicated AWS options table into a one-line
confirmation
✅ Deploy Preview for images-devsy-sh canceled.
|
📝 WalkthroughWalkthroughDocumentation-only updates revise Devsy Desktop and Devsy CLI headings, clarify workspace and provider instructions, refresh update guidance, and refine introductory wording across the Devsy documentation site. ChangesWorkspace guidance terminology
Provider management guidance
Update and introductory copy
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
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. Comment |
✅ Deploy Preview for devsydev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Prefer short noun-phrase headings over prepositional/gerund forms:
- 'Via Devsy Desktop Application' -> 'Devsy Desktop'
- 'Via Devsy CLI' -> 'Devsy CLI'
- 'Types of providers' -> 'Provider Types'
- 'Managing providers' -> 'Manage Providers'
- 'Adding a custom provider' -> 'Custom Providers'
- 'Managing options from Devsy {Desktop,CLI}' -> 'Options in {Desktop,the CLI}'
- 'Automatic stopping via a Provider' -> 'Automatic stop'
Also fix a dropped word in dotfiles ('command to a workspace' ->
'command to start a workspace'). No internal links reference the
changed anchors.
- add-provider: 'can be installed with' -> 'Install ... with'; 'Options ... can be set' -> 'Set options'; default-provider and per-provider-options sentences rewritten active and tightened - remove-provider: 'can be removed by using' -> 'Remove ... with' - what-is-devsy: 'every workspace is created and managed' -> 'Devsy creates and manages every workspace' Left appropriate passives in reference pages (developing-providers/*) and idiomatic 'is installed' phrasing untouched.
skevetter
changed the title
skevetter
marked this pull request as ready for review
July 24, 2026 20:24
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
sites/docs-devsy-sh/pages/managing-providers/add-provider.mdx (1)
32-32: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAvoid duplicating the custom-provider source list.
Line 32 already lists the GitHub link,
provider.yamlURL, and local path; lines 43-49 repeat the same content. Keep the details in one location and make the other section link to it.Also applies to: 43-49
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@sites/docs-devsy-sh/pages/managing-providers/add-provider.mdx` at line 32, Remove the duplicated custom-provider source list between the instruction at “Select” and the section covering lines 43-49, keeping the detailed GitHub link, provider.yaml URL, and local path guidance in one location. Update the other section to link to that retained guidance instead of repeating the list.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@sites/docs-devsy-sh/pages/getting-started/update.mdx`:
- Line 12: Update the Devsy Desktop update cadence wording in the
getting-started content to explicitly state that it checks for new releases
approximately every six hours instead of saying “every few hours”; preserve the
surrounding launch, download, and restart behavior.
In `@sites/docs-devsy-sh/pages/managing-providers/add-provider.mdx`:
- Around line 107-108: Update the sentence in the provider configuration
instructions to change “head over the `Providers` section” to “head over to the
`Providers` section,” preserving the rest of the wording.
In `@sites/docs-devsy-sh/pages/managing-providers/remove-provider.mdx`:
- Around line 11-12: Update the provider-removal sentence so it says “so you can
then remove the provider” instead of “in order to then remove the provider,”
while preserving the surrounding meaning.
---
Nitpick comments:
In `@sites/docs-devsy-sh/pages/managing-providers/add-provider.mdx`:
- Line 32: Remove the duplicated custom-provider source list between the
instruction at “Select” and the section covering lines 43-49, keeping the
detailed GitHub link, provider.yaml URL, and local path guidance in one
location. Update the other section to link to that retained guidance instead of
repeating the list.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4816c0cc-f5a7-4490-93a4-26e5002f3073
📒 Files selected for processing (12)
sites/docs-devsy-sh/pages/developing-in-workspaces/create-a-workspace.mdxsites/docs-devsy-sh/pages/developing-in-workspaces/credentials.mdxsites/docs-devsy-sh/pages/developing-in-workspaces/delete-a-workspace.mdxsites/docs-devsy-sh/pages/developing-in-workspaces/devcontainer-json.mdxsites/docs-devsy-sh/pages/developing-in-workspaces/dotfiles-in-a-workspace.mdxsites/docs-devsy-sh/pages/developing-in-workspaces/stop-a-workspace.mdxsites/docs-devsy-sh/pages/developing-in-workspaces/what-are-workspaces.mdxsites/docs-devsy-sh/pages/getting-started/update.mdxsites/docs-devsy-sh/pages/managing-providers/add-provider.mdxsites/docs-devsy-sh/pages/managing-providers/remove-provider.mdxsites/docs-devsy-sh/pages/managing-providers/what-are-providers.mdxsites/docs-devsy-sh/pages/what-is-devsy.mdx
| ## Devsy Desktop | ||
|
|
||
| Devsy Desktop checks GitHub for updates every 15 minutes. When an update is available, this popup confirms the update: | ||
| Devsy Desktop checks GitHub for new releases shortly after launch and every few hours while running. When an update is available, it downloads in the background and prompts you to restart. After you restart, Devsy runs the latest version. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document the approximately six-hour update interval.
“Every few hours” is ambiguous and does not implement the PR objective to correct the cadence to approximately six hours. Use explicit wording such as “about every six hours.”
Suggested wording
-Devsy Desktop checks GitHub for new releases shortly after launch and every few hours while running.
+Devsy Desktop checks GitHub for new releases shortly after launch and about every six hours while running.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Devsy Desktop checks GitHub for new releases shortly after launch and every few hours while running. When an update is available, it downloads in the background and prompts you to restart. After you restart, Devsy runs the latest version. | |
| Devsy Desktop checks GitHub for new releases shortly after launch and about every six hours while running. When an update is available, it downloads in the background and prompts you to restart. After you restart, Devsy runs the latest version. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@sites/docs-devsy-sh/pages/getting-started/update.mdx` at line 12, Update the
Devsy Desktop update cadence wording in the getting-started content to
explicitly state that it checks for new releases approximately every six hours
instead of saying “every few hours”; preserve the surrounding launch, download,
and restart behavior.
Comment on lines
107
to
108
| To manage options from the app, head over the `Providers` section, and click | ||
| `Edit` on the provider you want to configure. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add the missing preposition.
Change “head over the Providers section” to “head over to the Providers section.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@sites/docs-devsy-sh/pages/managing-providers/add-provider.mdx` around lines
107 - 108, Update the sentence in the provider configuration instructions to
change “head over the `Providers` section” to “head over to the `Providers`
section,” preserving the rest of the wording.
Comment on lines
11
to
12
| If a workspace is currently using the provider, you'll be prompted to first | ||
| remove that workspace, in order to then remove the provider. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Tighten the removal sentence.
Use “so you can then remove the provider” instead of “in order to then remove the provider.”
🧰 Tools
🪛 LanguageTool
[style] ~12-~12: Consider a more concise word here.
Context: ...rompted to first remove that workspace, in order to then remove the provider. ## Devsy CLI...
(IN_ORDER_TO_PREMIUM)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@sites/docs-devsy-sh/pages/managing-providers/remove-provider.mdx` around
lines 11 - 12, Update the provider-removal sentence so it says “so you can then
remove the provider” instead of “in order to then remove the provider,” while
preserving the surrounding meaning.
Source: Linters/SAST tools
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
1 participant
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
Follow-up to #740, extending the cleanup beyond install/quickstart. Fixes several stale/incorrect statements and aligns the voice of the conceptual pages with the polished onboarding docs.
Correctness (verified against the codebase)
userEnvProbe(--user-env-probeflag + handling inpkg/workspace/exec.go),waitFor(config.gofield + passing e2e testdocker-waitfor), and parallel lifecycle scripts (goroutine +sync.WaitGroupinpkg/devcontainer/setup/lifecyclehooks.go). It also had a typo (userEnvProve).RECHECK_INTERVAL_MS = 6 * 60 * 60 * 1000), not "every 15 minutes." Also dropped a dangling reference to a screenshot that doesn't exist and merged the two "Devsy Desktop" headings.Editorial
All referenced CLI commands and flags (
provider add/get/set/use/init,--available,--name,-o/--option,--single-machine) verified againstcmd/provider.Summary by CodeRabbit