Skip to content

Document Android documents provider in access vault and settings - #181

Open
iammajid wants to merge 3 commits into
developfrom
feature/android-documents-provider
Open

iammajid wants to merge 3 commits into
developfrom
feature/android-documents-provider

Conversation

@iammajid

@iammajid iammajid commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Adds docs for the documents provider from cryptomator/android#676. Vaults now show up in the Files app and the system file picker, so access-vault gets a new section for it and settings is updated to match what changed in the app.

Access vault

  • New "Access Vault from Other Apps" section with Files app screenshots: opening a vault, unlocking via SIGN IN, read-only access without the full version, conflict copies, failed uploads and how to retry.
  • "View and Edit File" no longer says you have to go back to Cryptomator for the upload to start.
  • The auto-lock note now says the timeout counts from the last use, including access through the Files app.

Settings

  • New "Show Vaults in the Files App".
  • Automatic Locking: counts from last use, new "Wait for transfers".
  • Cache rewritten: no size or age limit anymore, opened files are kept decrypted in the app's private storage, Clear Cache keeps pending uploads. "Cache Size Per Cloud" is removed.
  • "Workaround Opening Microsoft Files" is removed, and "Keep Unlocked" no longer refers to it.

@iammajid
iammajid requested a review from SailReal November 17, 2026 16:46
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Android documentation now describes vault access through Android Files and the system file picker. It covers opening and saving files, background uploads, conflict copies, rejected cloud changes, and upload retries. The settings documentation updates descriptions of automatic locking, transfer waiting, cached files, and Keep Unlocked behavior.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Other

Suggested reviewers: tobihagemann, infeo

Merge Risk: Minimal · up to 5576d

This pull request updates documentation for accessing vaults through the Android Files app and for the related settings. It has no runtime impact, and no merge-blocking issues were found.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: documentation for the Android documents provider in the access-vault and settings pages. The changeset adds an access-vault section for Files app and file picker acces…
Description check Passed The description states that the PR adds docs for the documents provider, lists the access-vault section (Files app access, unlocking, read-only access, conflict copies, failed uploads and retries) and…
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.
Full details: Title check

Explanation

The title names the main change: documentation for the Android documents provider in the access-vault and settings pages. The changeset adds an access-vault section for Files app and file picker access and updates settings for the same feature, so the title matches the main change.

Full details: Description check

Explanation

The description states that the PR adds docs for the documents provider, lists the access-vault section (Files app access, unlocking, read-only access, conflict copies, failed uploads and retries) and the settings updates (Show Vaults in the Files App, Automatic Locking, cache rewrite, removed Microsoft Files workaround). These match the raw summary of the changed files.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1f12ba88-bc68-4305-ab5f-b32d328d0518
Commits

Reviewing files that changed from the base of the PR and between ef545c9 and 5576d1f.

Files selected for processing: 2

  • docs/android/access-vault.mdx
  • docs/android/settings.mdx
Files skipped from review as they are similar to previous changes: 2

  • docs/android/access-vault.mdx
  • docs/android/settings.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Copilot AI 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.

🟡 Changes recommended

The documentation incorrectly implies that locking a vault revokes cached-file access, although an external editor with an already-open file can continue accessing its cached copy.

1 open issue
What changed in this PR

Updates the Android user documentation for the documents provider introduced in cryptomator/android#676, covering vault access through the Files app and system file picker.

Changes:

  • Adds illustrated guidance for opening vaults from other apps, write permissions, conflicts, and upload retries.
  • Updates editing and automatic-locking guidance for background uploads and external-app access.
  • Documents vault visibility, transfer-aware locking, and decrypted caching; removes obsolete settings guidance.
File Description
docs/​android/​settings.mdx Updates provider visibility, locking, cache behavior, and advanced settings documentation.
docs/​android/​access-vault.mdx Adds Files-app instructions and updates editing, upload, and locking guidance.

Review effort: Balanced

Comment thread docs/android/settings.mdx Resolved

Copilot AI 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.

🔵 Needs a closer look

The Android access guide incorrectly applies password/fingerprint unlocking to Hub vaults, which use browser authentication and may require device registration, potentially misleading Hub users.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Medium severity Clarify Hub vault authentication flow

docs/​android/​access-vault.mdx:212

This describes password/fingerprint unlocking as applying to every vault, but this section also covers Hub vaults. Hub vaults use browser authentication and may require device registration, as documented in docs/hub/user-guide/access-vault.mdx:26–46. Please distinguish that flow so Hub users aren't instructed to expect a vault-password prompt.

1 resolved since last review

Review effort: Balanced

This branch has not been deployed

No deployments
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