Skip to content

Conversation

tobihagemann
Copy link
Member

Updates macOS volume type documentation to provide clearer guidance on trade-offs between available options, based on feedback from @overheadhunter's community post (https://community.cryptomator.org/t/can-someone-explain-the-need-for-fuse-t/16040/2).

Copy link

coderabbitai bot commented Sep 18, 2025

Walkthrough

Edits are confined to docs/desktop/volume-type.md. The macOS/macFUSE section is reframed, with updated project and installation links, clarified licensing exclusions, a new note about deprecated OS APIs since macOS 12.3 and extra install steps, and an updated custom mount options link to the macFUSE wiki. The FUSE-T section now cautions on maturity, emphasizes user-space operation, and adds Homebrew installation commands. The WebDAV (AppleScript) section states no extra software is required and adds notes about expected localhost TLS warnings. General wording was aligned, default mount paths retained, and Linux/OS-independent cross-links updated.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Single documentation file with targeted rewrites, link updates, and added install snippet. Changes are heterogeneous in content but non-code, with clear, localized edits requiring verification of accuracy and links rather than deep logic review.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately summarizes the primary change—clarifying macOS volume type trade-offs and recommendations—and directly matches the documented updates in the changeset, making it clear and useful for a reviewer scanning PR history.
Description Check ✅ Passed The description clearly states that the PR updates macOS volume type documentation to clarify trade-offs and cites the community feedback that motivated the change, which aligns with the PR objectives and file-level summaries.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/clarify-volume-type-macos

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/desktop/volume-type.md (1)

104-109: FUSE‑T Homebrew tap/package present — update install command

  • Verified macos-fuse-t/homebrew-cask and macos-fuse-t/fuse-t repos exist and the project site is reachable. (github.com)
  • Upstream homebrew-cask repo includes a Cask for fuse‑t and recommends installing with brew install macos-fuse-t/homebrew-cask/fuse-t (Homebrew index also shows brew install --cask fuse-t). (github.com)
  • Current doc (docs/desktop/volume-type.md, lines 104–109) uses brew tap macos-fuse-t/homebrew-cask + brew install fuse-t — this will work after tapping, but update it to the explicit upstream command (recommended: brew install macos-fuse-t/homebrew-cask/fuse-t or add --cask) for clarity.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1126cb5 and 97d7a4c.

📒 Files selected for processing (1)
  • docs/desktop/volume-type.md (2 hunks)
🔇 Additional comments (6)
docs/desktop/volume-type.md (6)

84-88: LGTM! Clear and balanced guidance on macFUSE.

The reframing from a deprecation warning to positive guidance is excellent. This provides users with clear expectations about macFUSE being the most mature option while acknowledging the recovery mode requirement upfront.


91-91: Updated link correctly points to macFUSE wiki.

The link change from the old osxfuse documentation to the current macFUSE wiki is accurate and helpful.


93-97: Excellent clarification on macOS API deprecation.

This note effectively addresses user concerns by explaining the macOS 12.3 API deprecation context while reassuring users that macFUSE remains stable despite requiring additional installation steps.


102-109: Clear positioning of FUSE-T with installation instructions.

The description accurately positions FUSE-T as a user-space alternative and the Homebrew installation commands are correct and helpful for users.


114-117: Appropriately balanced warning about FUSE-T maturity.

The warning is well-calibrated - it acknowledges FUSE-T's less mature status and provides clear guidance to switch to macFUSE if issues arise, without being overly discouraging.


123-127: Excellent explanation of WebDAV security warnings.

The documentation now clearly explains that WebDAV requires no additional software and provides valuable context about the expected localhost TLS warnings, helping users understand this is normal behavior rather than a security concern.

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.

2 participants