Skip to content
This repository was archived by the owner on Jun 26, 2026. It is now read-only.

docs(readme): add deprecation banner pointing to Comfy-Org/Comfy-Desktop#1730

Open
deepme987 wants to merge 2 commits into
mainfrom
deepme987/desktop/deprecation-banner
Open

docs(readme): add deprecation banner pointing to Comfy-Org/Comfy-Desktop#1730
deepme987 wants to merge 2 commits into
mainfrom
deepme987/desktop/deprecation-banner

Conversation

@deepme987

@deepme987 deepme987 commented Jun 4, 2026

Copy link
Copy Markdown

Adds a GitHub-alert banner at the very top of the README pointing visitors to the rewrite at Comfy-Org/Comfy-Desktop.

  • New downloads: dl.comfy.org
  • Existing 0.9.x users: in-app update to the new version as we roll out
  • New issues / PRs / discussions: route to the new repo

The rest of the README is kept as historical reference — no content removed.

9-line addition.

Summary by CodeRabbit

  • Documentation
    • Added an important notice that the project has moved to a new GitHub home with updated links for downloads, issues, pull requests, and discussions.
    • Notified existing 0.9.x users they will receive an in-app update about the relocation.
    • Preserved the previous README content below the notice for reference.

This repo has been superseded by the rewrite at
Comfy-Org/Comfy-Desktop. Existing 0.9.x users will get an in-app
update to the new version; new downloads route through
dl.comfy.org. The rest of the README is kept as historical
reference.
@deepme987 deepme987 requested a review from a team as a code owner June 4, 2026 07:23
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jun 4, 2026
@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1c9f175f-6daa-4460-b5b9-bf15d6cca516

📥 Commits

Reviewing files that changed from the base of the PR and between 5e85c7c and ee94de8.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The README is updated with a prominent [!IMPORTANT] notice at the top redirecting users to the new Comfy-Org/Comfy-Desktop repository. The notice provides new download links, confirms that existing 0.9.x users will receive automatic in-app updates, and directs new issues, pull requests, and discussions to the new repository location.

Changes

Documentation Update

Layer / File(s) Summary
Repository move notice
README.md
Added [!IMPORTANT] callout at the top of README explaining the repository move to Comfy-Org/Comfy-Desktop, providing new download link(s), guidance for existing 0.9.x users regarding in-app updates, and directing new issues/PRs/discussions to the new repository.

Poem

🐰 A notice hops into the README's heart,
Pointing travelers to a brand new start,
Comfy Desktop finds its proper home,
No need to wander or to roam!
Old friends will update without a care.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately describes the main change: adding a deprecation banner to the README that points users to the new Comfy-Org/Comfy-Desktop repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch deepme987/desktop/deprecation-banner

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@README.md`:
- Line 7: Update the README sentence that currently guarantees automatic in-app
updates for "Existing 0.9.x users" so it reflects actual updater behavior:
change the wording to make the in-app update conditional on the user's
auto-update setting (Comfy-Desktop.AutoUpdate) and indicate that users with
auto-updates enabled will receive the update while others must update manually
or enable auto-updates; edit the line containing "Existing 0.9.x users"
accordingly.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0e627303-7cac-4c2e-9bc3-1afd7b433c9a

📥 Commits

Reviewing files that changed from the base of the PR and between e2d964b and 5e85c7c.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
> **This repository is no longer the home of Comfy Desktop.** The app has been rewritten and now lives at **[Comfy-Org/Comfy-Desktop](https://github.com/Comfy-Org/Comfy-Desktop)**.
>
> - **New downloads:** [dl.comfy.org](https://dl.comfy.org)
> - **Existing 0.9.x users:** your app will receive an in-app update to the new version as we roll out — no action needed.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Soften the in-app update guarantee to match actual updater behavior.

Line 7 currently guarantees automatic migration for all 0.9.x users, but updater behavior depends on user settings (Comfy-Desktop.AutoUpdate). Please make this conditional.

Suggested wording
-> - **Existing 0.9.x users:** your app will receive an in-app update to the new version as we roll out — no action needed.
+> - **Existing 0.9.x users:** if auto-update is enabled, your app should receive an in-app update to the new version as rollout progresses.
📝 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
> - **Existing 0.9.x users:** your app will receive an in-app update to the new version as we roll out — no action needed.
> - **Existing 0.9.x users:** if auto-update is enabled, your app should receive an in-app update to the new version as rollout progresses.
🤖 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 `@README.md` at line 7, Update the README sentence that currently guarantees
automatic in-app updates for "Existing 0.9.x users" so it reflects actual
updater behavior: change the wording to make the in-app update conditional on
the user's auto-update setting (Comfy-Desktop.AutoUpdate) and indicate that
users with auto-updates enabled will receive the update while others must update
manually or enable auto-updates; edit the line containing "Existing 0.9.x users"
accordingly.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant