Skip to content

docs(getting-started): document desktop update controls - #1726

Merged
skevetter merged 2 commits into
mainfrom
docs/update-desktop-updates-guide
Oct 31, 2026
Merged

skevetter merged 2 commits into
mainfrom
docs/update-desktop-updates-guide

Conversation

@skevetter

@skevetter skevetter commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Documents the Settings > Updates controls on the Desktop update page: Check now, Release channel (Stable or Preview), and automatic download with the Download update and Restart buttons.
  • Limits the background-download sentence to when automatic downloads are on (the default).

Why

The page says Desktop auto-updates but omits the controls users have. After this edit, readers can check for updates, select a channel, and control automatic downloads. This is the next target because the source verifies these controls and no open PR touches the page.

Validation

  • npm ci in sites/docs-devsy-sh fails on origin/main: package-lock.json is out of sync with package.json (EUSAGE). Not changed here.
  • npm run build fails on untouched pages too: fumadocs-core/mdx-plugins/stringifier has no embedSource export. Tried in a temp copy with fumadocs-core 16.15.18 and 16.17.8 and fumadocs-mdx 15.4.9 and 15.4.6. Build not verified.
  • npm run check-links in the temp copy (fumadocs-core 16.15.18, fumadocs-mdx 15.4.6): 0 errors.
  • @mdx-js/mdx compile of the changed file: OK.

CodeRabbit CLI

coderabbit review --agent --committed --base-commit c9a7e55e3e936c34492e297a140309d1a16fe5d6 on 33ad6ea9d: completed, 0 findings, reviewed update.mdx.

Auto-merge

Content-only: yes. Changed lines: 8 (+7/-1), one file.

Next

Fix the docs-site dependency pins (lockfile out of sync; fumadocs-core and fumadocs-mdx mismatch) so npm run build runs, then re-verify this page.

Type of change

  • Documentation

AI assistance

  • AI-assisted (drafted and validated with an agent; diff reviewed)

Testing

See Validation.

Checklist

  • Docs content only; no product code changes
  • One file changed
  • npm run build passes (blocked, see Validation)
  • Link check passes (temp copy)

Notes for reviewers

Draft only. Build blocker is pre-existing on origin/main and affects every MDX page, not this edit.

Summary by CodeRabbit

  • Documentation
    • Clarified that updates download in the background when automatic downloads are enabled, which is the default.
    • Added instructions for checking for updates, selecting Stable or Preview, and switching from Preview to Stable.
    • Explained that Devsy will not automatically downgrade if Stable is behind Preview. When automatic downloads are off, users can download updates manually and restart to install them.

@skevetter skevetter added the docs-cleanup Docs cleanup (maintenance bot) label Oct 26, 2026
@netlify

netlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

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

@netlify

netlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit b8c77c7
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6ae572e9dc2ed15b34937459
😎 Deploy Preview https://deploy-preview-1726--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 26, 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: 8fb1fd86-f1ad-42a8-9a01-b32ee8d55f06
Commits

Reviewing files that changed from the base of the PR and between 9bc12ee and b8c77c7.

Files selected for processing: 1
  • sites/docs-devsy-sh/content/docs/getting-started/update.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 Devsy Desktop update guide now explains the default automatic-download setting and describes how to check for updates, select a release channel, download an update manually, and restart to install it.

Changes: Devsy Desktop update documentation

Layer / File(s) Summary
Update settings instructions
sites/docs-devsy-sh/content/docs/getting-started/update.mdx
The guide states that automatic downloads are enabled by default. It explains update checks, release channel selection and confirmation, no automatic downgrade, manual downloads, and restarting to install.

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

Change: Other

Merge Risk: Minimal · up to b8c77

No concrete merge-blocking risk is established for these documentation changes. The full site build remains unverified.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title is concise, specific, and accurately describes the documentation change.
Description check Passed The description clearly explains what changed, why it changed, the documentation type, AI assistance, validation results, and the known build blocker. Some template details are omitted, including the …
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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 clearly explains what changed, why it changed, the documentation type, AI assistance, validation results, and the known build blocker. Some template details are omitted, including the issue reference and AI tool metadata, but the description is mostly complete.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

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

Copy link
Copy Markdown
Contributor Author

Needs human: the docs deploy preview fails on this head; the base docs dependencies are out of sync and the site build also fails on untouched MDX pages with a missing Fumadocs embedSource export.

@skevetter
skevetter marked this pull request as ready for review October 31, 2026 05:01
@mergify

mergify Bot commented Oct 31, 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 3242016 into main Oct 31, 2026
35 checks passed
@skevetter
skevetter deleted the docs/update-desktop-updates-guide branch October 31, 2026 05:29
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