Skip to content

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

Open
iammajid wants to merge 1 commit into
developfrom
feature/android-documents-provider
Open

iammajid wants to merge 1 commit 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 access to vaults through the Files app and system file picker, including file opening, saving, background uploads, and upload failures. It also updates the descriptions of Files app integration settings, automatic locking, cached files, and Keep Unlocked behavior.

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

Change: Other

Suggested reviewers: tobihagemann, sailreal, infeo

Merge Risk: Minimal · up to a0c48

This change updates the Android documentation for accessing vaults through the Files app and for the related settings. No concrete defect was established in the documentation text. The author should confirm the described provider behavior (own-browser saves, locking while a file is open, and removal of the Microsoft workaround) against the Android app release before publishing.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the Android documents provider and the two docs pages it changes (access vault and settings). The changeset adds a documents provider section to access-vault and updates settings to ma…
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.
Description check Passed The description states the PR adds documentation for the Android documents provider (cryptomator/android#676). It covers the new Access Vault section about the Files app, and the Settings updates for …
Full details: Title check

Explanation

The title names the Android documents provider and the two docs pages it changes (access vault and settings). The changeset adds a documents provider section to access-vault and updates settings to match, so the title matches the main change.

Full details: Description check

Explanation

The description states the PR adds documentation for the Android documents provider (cryptomator/android#676). It covers the new Access Vault section about the Files app, and the Settings updates for Show Vaults in the Files App, Automatic Locking, the cache rewrite, and the removed Microsoft workaround. This matches the changed files docs/android/access-vault.mdx and docs/android/settings.mdx.

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: 560c3096-3de7-43f8-bb35-1e230148ee47
Commits

Reviewing files that changed from the base of the PR and between e10cef2 and a0c4836.

Files ignored due to path filters: 4

  • static/img/android/files-app-0-vaults.png is excluded by !**/*.png
  • static/img/android/files-app-1-locked.png is excluded by !**/*.png
  • static/img/android/files-app-2-unlock.png is excluded by !**/*.png
  • static/img/android/files-app-3-unlocked.png is excluded by !**/*.png
Files selected for processing: 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
### Cache Size Per Cloud {/* #cache-size-per-cloud */}

Using this setting, you can specify the total max cache size per Cloud Service.
Cryptomator keeps the folder contents of your vaults and a copy of each opened file on the device. This way, folders and files that have been opened before show up right away, both in Cryptomator and in the Files app. The copies of opened files are stored decrypted in Cryptomator's private app storage, which other apps can't access. Both are kept when a vault gets locked, but can only be accessed after it has been unlocked again.

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