docs: update install and quick start pages#740
Conversation
Focus the first-60-seconds path (what-is-devsy -> install -> quickstart) on clear value, direct prose, and no adverbs. - install: lead with the Desktop vs CLI choice, collapse four stacked info boxes into two, add a version verify step and a Next step link - quickstart: reframe around the outcome, lead with the CLI path, number the steps, trim the SSH/Vim detail - what-is-devsy: remove adverbs and tighten two sentences CLI commands and --ide values verified against the codebase.
✅ Deploy Preview for devsydev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 50 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe documentation now presents separate Desktop and CLI installation paths, expands the CLI and Desktop Quick Start workflows, updates SSH guidance, and revises introductory Devsy positioning copy. ChangesOnboarding documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 images-devsy-sh canceled.
|
skevetter
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/install.mdx`:
- Line 10: Update the opening sentence in the installation documentation to use
clear, grammatically correct wording that introduces the two available ways to
use Devsy without stating that they “work the same way.”
In `@sites/docs-devsy-sh/pages/quickstart/quickstart.mdx`:
- Around line 8-17: Update the quickstart introduction to describe all supported
connection paths, including browser-based OpenVSCode via --ide openvscode and
SSH via --ide none, rather than implying every workflow requires a local editor.
Keep the existing local-editor guidance for VS Code and JetBrains workflows, and
align the prerequisites wording with these alternatives.
🪄 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: dcefd395-f8dc-43a3-bfe4-7f1f910b9928
📒 Files selected for processing (3)
sites/docs-devsy-sh/pages/getting-started/install.mdxsites/docs-devsy-sh/pages/quickstart/quickstart.mdxsites/docs-devsy-sh/pages/what-is-devsy.mdx
- install: reword the opening to not imply the two forms 'work the same way' - quickstart: lead with the no-local-install paths (openvscode browser, none/SSH) so it doesn't imply every workflow needs a local editor
1 participant
Summary
Refreshes the highest-value onboarding docs so the first 60 seconds land: what-is-devsy → install → quick start. The prose is direct and adverb-free, organized around the value a user gets.
devsy --versionverify step and a closing link into Quick Start.Verification
CLI surface confirmed against the codebase:
devsy provider add,devsy workspace up [path],--idevaluesnone/vscode/openvscode, anddevsy --version(noversionsubcommand). Internal doc links resolve.Not independently verified (carried over unchanged): release download URLs, Linux dependency package lists, and the Desktop wizard UI labels.
Summary by CodeRabbit