Skip to content

docs: revert desktop warning#10040

Merged
mendonk merged 1 commit into
mainfrom
docs-revert-desktop-publish
Sep 30, 2025
Merged

docs: revert desktop warning#10040
mendonk merged 1 commit into
mainfrom
docs-revert-desktop-publish

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Sep 30, 2025

Not released yet.

Summary by CodeRabbit

  • Documentation
    • Removed outdated Windows Desktop warning about avoiding in-app upgrade to 1.6.0 across README, Installation guide, and Release Notes.
    • Deleted the “Known issue: Don’t auto-upgrade Windows Desktop” section and related backup/upgrade steps from the 1.6.0 notes.
    • Kept existing CVE cautions and 1.6.0 breaking change notes unchanged.
    • No functional or API changes.

@mendonk mendonk self-assigned this Sep 30, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 30, 2025

Walkthrough

Removed Windows Desktop–specific warnings about in-app updates to version 1.6.0 from README and documentation pages, including installation and release notes. No code or API changes; only documentation text deletions.

Changes

Cohort / File(s) Summary of Changes
Docs: Remove Windows Desktop in-app update warnings
docs/docs/Get-Started/get-started-installation.mdx, docs/docs/Support/release-notes.mdx
Deleted Windows-specific admonitions and known-issue sections advising against in-app upgrade to 1.6.0, including related steps/links. Other content unchanged.
README cleanup
README.md
Removed single Windows-specific caution line about not using in-app update to 1.6.0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

documentation, size:M, lgtm

Suggested reviewers

  • italojohnny
  • Cristhianzl
  • aimurphy

Pre-merge checks and finishing touches

✅ Passed checks (7 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “docs: revert desktop warning” is a concise, single-sentence summary that accurately captures the primary change of removing the desktop warning in the documentation without extraneous detail or ambiguity, making it clear to anyone reviewing the project history.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Test Coverage For New Implementations ✅ Passed This PR exclusively alters documentation files without introducing any new code, features, or bug fixes; as there are no code changes or new functionality to validate, there is no requirement for additional tests.
Test Quality And Coverage ✅ Passed The pull request only modifies documentation files (README and MDX docs) without introducing any new or altered functionality, so there are no implementation changes requiring test coverage or quality assessment under the project’s testing patterns. Therefore, the absence of related tests is expected and does not violate any test quality criteria.
Test File Naming And Structure ✅ Passed This pull request only modifies documentation files (README.md and two .mdx files) and does not add, remove, or alter any test files; therefore there are no test files to inspect for naming conventions, structure, or coverage requirements, making the check trivially satisfied.
Excessive Mock Usage Warning ✅ Passed This pull request solely updates documentation files and does not touch any test code, so there are no new or modified mock usages to evaluate; consequently, there is no risk of introducing excessively mocked tests in this changeset.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-revert-desktop-publish

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a58c8da and 6b6db7d.

📒 Files selected for processing (3)
  • README.md (0 hunks)
  • docs/docs/Get-Started/get-started-installation.mdx (0 hunks)
  • docs/docs/Support/release-notes.mdx (0 hunks)
💤 Files with no reviewable changes (3)
  • docs/docs/Get-Started/get-started-installation.mdx
  • README.md
  • docs/docs/Support/release-notes.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Test Docs Build / Test Docs Build
  • GitHub Check: build-and-deploy

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
🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • Public repositories are always opted into early access features.
  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 30, 2025
@sonarqubecloud
Copy link
Copy Markdown

@rodrigosnader rodrigosnader self-requested a review September 30, 2025 02:46
Copy link
Copy Markdown
Contributor

@rodrigosnader rodrigosnader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Sep 30, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 30, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 30, 2025
@mendonk mendonk added this pull request to the merge queue Sep 30, 2025
Merged via the queue into main with commit 2bd0b66 Sep 30, 2025
19 checks passed
@mendonk mendonk deleted the docs-revert-desktop-publish branch September 30, 2025 03:02
@coderabbitai coderabbitai Bot mentioned this pull request Nov 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants