Feature: Add Info about vault recovery options #98
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds a new documentation page at docs/desktop/vault-recovery.md titled "Vault Recovery". The page documents how to recover missing vault configuration files and masterkey files to re-enable recognizing and unlocking a vault. It lists recovery scenarios (recover masterkey, recover vault config, recover both), describes required credentials (Recovery Key or vault password), notes support begins with Vault Format 8 (Cryptomator 1.6.0), explains UI indications and in-app recovery flows (from vault list, Vault Details, and during import), and clarifies restrictions for Cryptomator Hub-created vaults. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/desktop/vault-recovery.md (1)
26-26: Minor: Reduce wordiness.The phrase "are not compatible with" can be shortened to "are incompatible with" for conciseness. This is a minor style improvement that makes the warning more direct.
Apply this diff:
-Vaults created with older formats (e.g., Vault Format 7 or earlier) are not compatible with these recovery options. +Vaults created with older formats (e.g., Vault Format 7 or earlier) are incompatible with these recovery options.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/desktop/vault-recovery.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/desktop/vault-recovery.md
[grammar] ~18-~18: Ensure spelling is correct
Context: ...s with the following scenarios: 1. The masterkey file is missing or damaged - [`Recover ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~20-~20: Ensure spelling is correct
Context: ...ig file`](#recover-vault-config) 1. The masterkey and the vault config files are missing ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~26-~26: Consider using “incompatible” to avoid wordiness.
Context: ...s (e.g., Vault Format 7 or earlier) are not compatible with these recovery options. For detail...
(NOT_ABLE_PREMIUM)
[grammar] ~38-~38: Ensure spelling is correct
Context: ...der. - Or check the option “Restore the masterkey file instead” and click Restore. For...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~40-~40: Ensure spelling is correct
Context: ...d the vault recovery key to restore the masterkey file. You’ll be guided through the reco...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (4)
docs/desktop/vault-recovery.md (4)
1-5: Frontmatter looks good.The YAML frontmatter is properly formatted with a valid
id, cleartitle, and reasonablesidebar_position.
7-28: Clear introduction and well-structured navigation.The opening clearly explains the feature's purpose, includes a helpful note about what recovery does/doesn't do, and provides both a scenario index and an important compatibility warning for Vault Format 8+. The structure effectively guides users to the right section.
30-68: Recovery scenarios are clear and well-organized.Each scenario (Recover Masterkey, Recover Vault config, Recover both) has distinct UI-level guidance with button labels in backticks and clear instructions. The Cryptomator Hub caveat on lines 56–58 is appropriately placed to prevent user frustration.
69-78: Import-time recovery guidance is comprehensive.The section on recovering during vault import is clear and logically completes the user journey. Instructions for navigating the UI (clicking the
+button and selecting "Recover Existing Vault…") are concrete and actionable. Internal link to vault format history is valid and properly referenced.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for the Vault Recovery feature in Cryptomator Desktop. The documentation explains how users can recover vaults when configuration files are missing or damaged.
Key changes:
- Added complete vault recovery documentation covering three recovery scenarios
- Documented the recovery process for masterkey files, vault config files, and both files together
- Included instructions for adding and recovering vaults that aren't yet imported into Cryptomator
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Apply suggestion from @Copilot Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/desktop/vault-recovery.md (1)
26-26: Minor style improvement: simplify phrasing.Line 26 uses "are not compatible" where the more concise "are incompatible" would be equally clear and idiomatic.
-Vaults created with older formats (e.g., Vault Format 7 or earlier) are not compatible with these recovery options. +Vaults created with older formats (e.g., Vault Format 7 or earlier) are incompatible with these recovery options.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/desktop/vault-recovery.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/desktop/vault-recovery.md
[grammar] ~18-~18: Ensure spelling is correct
Context: ...s with the following scenarios: 1. The masterkey file is missing or damaged - [`Recover ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~20-~20: Ensure spelling is correct
Context: ...ig file`](#recover-vault-config) 1. The masterkey and the vault config files are missing ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~26-~26: Consider using “incompatible” to avoid wordiness.
Context: ...s (e.g., Vault Format 7 or earlier) are not compatible with these recovery options. For detail...
(NOT_ABLE_PREMIUM)
[grammar] ~38-~38: Ensure spelling is correct
Context: ...der. - Or check the option “Restore the masterkey file instead” and click Restore. For...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~40-~40: Ensure spelling is correct
Context: ...d the vault recovery key to restore the masterkey file. You’ll be guided through the reco...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (2)
docs/desktop/vault-recovery.md (2)
1-79: Well-structured and comprehensive documentation for vault recovery feature.The new documentation page provides clear, step-by-step guidance covering all vault recovery scenarios with proper UI cues and user actions. The structure progresses logically from overview to specific recovery paths. The sections on Cryptomator Hub limitations (lines 55–58) and format support (lines 24–28) appropriately address important restrictions and compatibility.
The grammatical issues flagged in past reviews have been properly corrected (lines 22, 71: "has not yet been added").
18-18: False positives from static analysis; no action needed.LanguageTool flagged multiple instances of "masterkey" as spelling/orthography errors. These are false positives—"masterkey" is the correct technical term for the vault's master key file, used consistently throughout the documentation and the Cryptomator codebase.
Also applies to: 20-20, 38-38, 40-40
See cryptomator/cryptomator#3821 for details.