Skip to content

Document Linux zenity requirement for AppImage installs#8780

Open
miachillgood wants to merge 1 commit into
AppFlowy-IO:mainfrom
miachillgood:codex/document-linux-zenity-requirement
Open

Document Linux zenity requirement for AppImage installs#8780
miachillgood wants to merge 1 commit into
AppFlowy-IO:mainfrom
miachillgood:codex/document-linux-zenity-requirement

Conversation

@miachillgood

@miachillgood miachillgood commented Jun 1, 2026

Copy link
Copy Markdown

Summary

  • Add a Linux installation note that minimal desktop environments may need zenity for the folder picker when using AppImage or .tar.gz packages.
  • Mention that Flatpak typically includes the required portal integration.

Fixes #3973.

Validation

  • git diff --check

Summary by Sourcery

Documentation:

  • Add a note explaining that minimal Linux desktop environments may need zenity installed for the folder picker to work with AppImage or .tar.gz packages and that Flatpak usually includes the necessary portal integration.

@sourcery-ai

sourcery-ai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documents a Linux-specific requirement that minimal desktop environments may need zenity installed for AppImage or .tar.gz usage, clarifying behavior relative to Flatpak, by updating the README installation instructions.

Flow diagram for Linux installation options and zenity requirement

flowchart TD
    A[Linux_user] --> B[Choose_installation_method]
    B --> C[AppImage_or_tar_gz]
    B --> D[Flatpak]

    C --> E{Minimal_desktop_environment?}
    E -->|Yes| F[Install_zenity]
    E -->|No| G[Run_AppFlowy]
    F --> G

    D --> H[Use_Flatpak_with_portal_integration]
    H --> G
Loading

File-Level Changes

Change Details Files
Update Linux user installation documentation with zenity requirement and Flatpak note.
  • Add a sub-bullet under the desktop download link explaining that minimal Linux desktop environments should install zenity before using the AppImage or .tar.gz archive so the folder picker works correctly
  • Clarify that Flatpak builds typically include the necessary portal integration, distinguishing them from AppImage/.tar.gz distributions
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#3973 Update Linux installation documentation to state that minimal desktop environments must have zenity installed for the folder picker to work when using the AppImage or .tar.gz packages, and clarify that Flatpak generally includes the necessary integration.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLAassistant

CLAassistant commented Jun 1, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Documentation: Installation on Linux

2 participants