Add "Recover Existing Vault…" to Desktop/Adding Vaults#117
Add "Recover Existing Vault…" to Desktop/Adding Vaults#117
Conversation
WalkthroughThis PR updates the documentation for adding vaults in Cryptomator Desktop by adding a third option to the existing list. The change modifies the introductory statement to reflect three options instead of two and introduces "Recover Existing Vault…" as a new option with a link to the vault recovery documentation. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/desktop/adding-vaults.md (1)
13-13: Optional wording tightening."a vault with missing configuration files that hasn't yet been added" — the relative clause "that hasn't yet been added" can read as modifying "files" rather than "vault", and the overall sentence is slightly long.
✏️ Suggested rewording
-3. [`Recover Existing Vault…`](/docs/desktop/vault-recovery.md#add-recover-vault) - Choose this if you have a vault with missing configuration files that hasn't yet been added and you want to restore it. +3. [`Recover Existing Vault…`](/docs/desktop/vault-recovery.md#add-recover-vault) - Choose this if you want to restore a vault whose configuration files are missing and that hasn't been added to Cryptomator yet.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/desktop/adding-vaults.md` at line 13, Rewrite the third bullet ("Recover Existing Vault…") to tighten wording and ensure "vault" — not "files" — is what hasn't been added; replace the current sentence with a clearer, shorter phrase such as: "Recover Existing Vault… - Choose this if you have a vault that hasn’t been added because it’s missing configuration files and you want to restore it." Update the text for the bullet labeled "Recover Existing Vault…" accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/desktop/adding-vaults.md`:
- Line 15: Update the Image element in docs/desktop/adding-vaults.md so the alt
attribute accurately describes all three visible options; replace the current
alt="Create a new or open an existing vault" on the <Image
src="/img/desktop/create-or-open-vault.png" ... /> tag with text that includes
"Create a new", "Open an existing", and "Recover existing vault" (or equivalent
phrasing) to reflect the screenshot content.
---
Nitpick comments:
In `@docs/desktop/adding-vaults.md`:
- Line 13: Rewrite the third bullet ("Recover Existing Vault…") to tighten
wording and ensure "vault" — not "files" — is what hasn't been added; replace
the current sentence with a clearer, shorter phrase such as: "Recover Existing
Vault… - Choose this if you have a vault that hasn’t been added because it’s
missing configuration files and you want to restore it." Update the text for the
bullet labeled "Recover Existing Vault…" accordingly.
| 2. [`Open Existing Vault…`](#open-an-existing-vault) - Choose this if you already have a vault and wish to open it. | ||
| 3. [`Recover Existing Vault…`](/docs/desktop/vault-recovery.md#add-recover-vault) - Choose this if you have a vault with missing configuration files that hasn’t yet been added and you want to restore it. | ||
|
|
||
| <Image src="/img/desktop/create-or-open-vault.png" alt="Create a new or open an existing vault" width="762" height="610" /> |
There was a problem hiding this comment.
Update the alt text to reflect all three options.
The alt text still reads "Create a new or open an existing vault". If the screenshot has been updated (as stated in the PR description) to show the "Recover Existing Vault…" option, this alt text is now stale and no longer accurately describes the image — a direct accessibility regression introduced by this PR.
✏️ Proposed fix
-<Image src="/img/desktop/create-or-open-vault.png" alt="Create a new or open an existing vault" width="762" height="610" />
+<Image src="/img/desktop/create-or-open-vault.png" alt="Create a new vault, open an existing vault, or recover an existing vault" width="762" height="610" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Image src="/img/desktop/create-or-open-vault.png" alt="Create a new or open an existing vault" width="762" height="610" /> | |
| <Image src="/img/desktop/create-or-open-vault.png" alt="Create a new vault, open an existing vault, or recover an existing vault" width="762" height="610" /> |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/desktop/adding-vaults.md` at line 15, Update the Image element in
docs/desktop/adding-vaults.md so the alt attribute accurately describes all
three visible options; replace the current alt="Create a new or open an existing
vault" on the <Image src="/img/desktop/create-or-open-vault.png" ... /> tag with
text that includes "Create a new", "Open an existing", and "Recover existing
vault" (or equivalent phrasing) to reflect the screenshot content.
Updates the screenshot on the Desktop/Adding Vaults documentation page to reflect the current UI and adds the missing third “Adding Vault” option to the list. This ensures the documentation is aligned with the latest Desktop version and avoids confusion for users.
Fixes #109