docs: windows desktop update issue

[mendonk]

Instructions preview

1. Add recommended steps for upgrading Windows Desktop to 1.6.0 in Release Notes.
2. Add a warning and a link to these instructions from the Install Windows Desktop page.
3. Add a caution and a link from README.md to the instructions.

Summary by CodeRabbit

• Documentation
  • Added a Windows-specific warning in the Desktop installation guide advising against using the in-app update to upgrade to version 1.6.0, with a link to detailed guidance.
  • Expanded 1.6.0 release notes with a “Windows Desktop update issue” section outlining data-loss risks, required manual upgrade steps, backup instructions, default database paths, and administrator permissions needed for a safe migration.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Adds Windows-specific warning to Desktop installation docs and inserts a new 1.6.0 release-notes subsection detailing risks with in-app updates on Windows and manual upgrade/backup steps. No code changes.

Changes

Cohort / File(s)	Summary of Changes
Windows Desktop install warning docs/docs/Get-Started/get-started-installation.mdx	Added a Windows-tab warning advising not to use in-app update for upgrading to Langflow 1.6.0; links to release-notes anchor.
Release notes update guidance docs/docs/Support/release-notes.mdx	Added “Windows Desktop update issue” under 1.6.0 with explanation of data-loss risk, manual upgrade steps, default DB paths, and admin requirements.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• docs: refactor installation page #8487 — Also updates Windows Desktop installation docs structure; related to the new Windows-specific warning.
• docs: hide windows for desktop installation #8707 — Adjusts Windows desktop installation visibility; overlaps with Windows installation guidance changes.
• docs: troubleshooting backlog items #9474 — Touches installation and release notes about Desktop update/upgrade issues; overlaps in topic and files.

Suggested labels

documentation, size:M, lgtm

Suggested reviewers

• italojohnny
• aimurphy
• Cristhianzl

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title "docs: windows desktop update issue" is partially related to the changeset but lacks specificity about the main change. The changeset adds documentation about a Windows Desktop upgrade issue for version 1.6.0, including warnings and manual upgrade procedures to prevent data loss. While the title correctly identifies that this is a documentation change related to Windows Desktop and an update issue, it doesn't clearly convey that this is about adding upgrade warnings and instructions, making it somewhat vague for someone scanning the history to understand the primary change.	Consider revising the title to be more specific about the actual change, such as "docs: add Windows Desktop 1.6.0 upgrade warning and manual migration steps" or "docs: document Windows Desktop upgrade issue for version 1.6.0". This would make it clearer that the PR adds warnings and instructions rather than just documenting a generic issue, helping teammates better understand the nature of the change when reviewing pull request history.

✅ Passed checks (6 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Test Coverage For New Implementations	✅ Passed	This PR contains only documentation changes to two MDX files: one adding a warning to the installation guide and another adding detailed upgrade instructions to the release notes. No code implementation, components, features, or bug fixes are included in this PR. Documentation changes do not require test coverage as they do not introduce executable code that can be tested programmatically. The changes are purely informational content updates to warn users about a Windows Desktop upgrade issue.
Test Quality And Coverage	✅ Passed	This pull request consists exclusively of documentation changes to two MDX files: adding a warning about Windows Desktop update issues in the installation guide and providing detailed upgrade instructions in the release notes. Since this PR only modifies documentation files and does not introduce any new code implementations, API endpoints, functions, or features that would require testing, the test quality and coverage check is not applicable. The changes are purely informational content updates to warn users about a known issue and provide remediation steps, which do not require automated tests to validate their correctness.
Test File Naming And Structure	✅ Passed	This pull request contains only documentation changes to two .mdx (Markdown with JSX) files: get-started-installation.mdx and release-notes.mdx. The changes add a Windows-specific warning about the in-app update feature for version 1.6.0 and provide manual upgrade instructions. Since no code functionality is being added, modified, or removed, and no backend or frontend logic is being changed, there are no test files expected or required for this PR. The custom check criteria for test file naming and structure is not applicable to documentation-only changes.
Excessive Mock Usage Warning	✅ Passed	This pull request only modifies documentation files (two .mdx files in the docs/ directory) and does not include any test files. The changes add warnings and instructions about Windows Desktop upgrade issues for Langflow version 1.6.0. Since no test files are present in this PR, there are no mocks to evaluate, making this check not applicable to the current changes.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🧪 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.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/docs/Support/release-notes.mdx (2)

77-77: Consider consistent emphasis for UI actions.

The text "Run as administrator" describes a UI action and could benefit from bold formatting for consistency with the style guide's recommendation to use bold for UI elements.

-6. Run the Windows installer as an Administrator. To run the installer as an Administrator, right-click the executable and select **Run as administrator**.
+6. Run the Windows installer as an Administrator. To run the installer as an Administrator, right-click the executable and select **Run as administrator**.

Note: The second instance already has bold formatting. Consider if the action description in the first sentence also warrants emphasis.

As per coding guidelines.

---

82-82: Consider providing explicit paths for the data directory.

For improved clarity, consider providing the full explicit path when referencing "the version 1.6.0 Langflow installation's data directory" on lines 82 and 87, especially since the default path was specified earlier (line 67).

This would help users locate the correct directory without ambiguity, particularly less experienced Windows users who may not be familiar with navigating to application data directories.

Also applies to: 87-87

📜 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 78fe7c1 and 4bacb36.

📒 Files selected for processing (2)

• docs/docs/Get-Started/get-started-installation.mdx (1 hunks)
• docs/docs/Support/release-notes.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

• docs/docs/Get-Started/get-started-installation.mdx
• 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

🔇 Additional comments (5)

docs/docs/Get-Started/get-started-installation.mdx (1)

39-43: LGTM! Clear warning placement for Windows users.

The warning admonition is well-placed within the Windows installation tab, uses appropriate emphasis, and correctly scopes the issue to Windows Desktop users migrating to version 1.6.0. The link to the detailed release notes provides users with comprehensive upgrade instructions.

docs/docs/Support/release-notes.mdx (4)

54-54: LGTM! Properly anchored section title.

The section title uses appropriate heading level and includes the correct anchor ID that matches the link reference from the installation documentation.

---

56-59: LGTM! Consistent warning message.

The warning admonition maintains consistency with the installation page warning, appropriately emphasizes the critical information, and clearly defines the affected user group.

---

61-90: Well-structured upgrade instructions with comprehensive safety measures.

The upgrade instructions provide a thorough step-by-step process that appropriately emphasizes data safety through:

• Prerequisite checks (administrator privileges, disk space)
• Multiple backup strategies (automatic installer backup + recommended manual backup)
• Clear recovery procedure if flows are missing
• Specific guidance on administrator execution of the installer

The logical flow guides users from preparation through installation to verification and potential recovery.

---

67-67: Format file paths with inline code backticks.

The file paths should use inline code formatting with backticks for consistency and clarity, per the style guide requirement to use inline code with backticks.

Apply this approach throughout the section:

-These instructions assume the default path for the Langflow database of `C:\Users\YOUR_USERNAME\AppData\Roaming\com.langflow\data\database.db` or `C:\Users\%YOUR_USERNAME%\AppData\Roaming\com.langflow\data\database.db`. Replace `YOUR_USERNAME` with your Windows username.
+These instructions assume the default path for the Langflow database of `C:\Users\YOUR_USERNAME\AppData\Roaming\com.langflow\data\database.db` or `C:\Users\%YOUR_USERNAME%\AppData\Roaming\com.langflow\data\database.db`. Replace `YOUR_USERNAME` with your Windows username.

Note: The paths already have backticks in this line, but ensure all path references throughout lines 74, 82, and 87 also use backticks consistently.

As per coding guidelines.

Likely an incorrect or invalid review comment.

[aimurphy]

Approved with a few suggestions. You have a mix of "you" and "users", but it's probably fine although 2nd person is preferred.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

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