Add descriptions of general vault options #82
Conversation
Adds descriptions of general vault options, allowing people to read about options not shown in the screenshot (After successful unlock options) and learn how to rename a vault.
|
|
WalkthroughThe documentation for vault options in the desktop application has been expanded to provide more detailed descriptions of several general vault settings. The updates include explanations for the editable vault name field, an automatic lock feature based on inactivity duration, and an option to unlock the vault automatically when the application starts. Additionally, a new subsection describes the possible actions that can occur after a successful vault unlock, such as doing nothing, revealing the mounted drive in the file manager, or prompting the user to select an action. These changes enhance the clarity and completeness of the vault options section without modifying any existing content or altering the control flow. Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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 (2)
source/desktop/vault-management.rst (2)
51-53: Replace ambiguous placeholder and clarify UI textThe placeholder
__ minutescan be easily mistaken for RST syntax. Consider using a clearer placeholder (e.g.,<n>) and/or wrapping the entire option label in inline literals or a Sphinx UI role (such as:guilabel:) to distinguish it from markup:Example diff:
- **Lock when idle for __ minutes**: The vault will be locked automatically after the specified time of inactivity. + **Lock when idle for <n> minutes**: The vault will be locked automatically after the specified time of inactivity.Or, using a role:
- **Lock when idle for __ minutes**: The vault will be locked automatically … + :guilabel:`Lock when idle for <n> minutes`: The vault will be locked automatically …
54-57: Append colon to 'After successful unlock' and call out screenshot gapFor consistency with the other top-level bullets (which all terminate with a colon), add a colon here. Additionally, since this section isn’t visible in the existing screenshot (
vault-options-general.png), consider adding a brief note above the list—or updating the image—to indicate that these “After successful unlock” options are explained below but not shown in the screenshot.Example diff:
- - **After successful unlock** + - **After successful unlock**:
Uses backticks in UI labels for clarity, uses a dash separator instead of a colon to match other sections.
source/desktop/vault-management.rst
Outdated
| @@ -48,6 +48,14 @@ You can select this option if the vault is unlocked as soon as Cryptomator start | |||
| .. image:: ../img/desktop/vault-options-general.png | |||
| :alt: General vault options | |||
|
|
|||
| - ``Vault Name`` - The name of the vault. *You can edit this field to rename the vault.* | |||
| - ``Lock when idle for <n> minutes`` - The vault will be locked automatically after the specified time of inactivity. | |||
| - ``Unlock vault when starting Cryptomator`` - On startup, Cryptomator will automatically unlock the vault if it is not already unlocked. | |||
There was a problem hiding this comment.
This description is misleading.
- the vault is unlocked on app start, not during the OS startup.
- a vault can only be unlocked, if Cryptomator is running. Hence, it cannot be already unlocked.
There was a problem hiding this comment.
Fixed! Thank you for pointing that out.
Fixes the incorrect description of Cryptomator's behavior for `Unlock vault when starting Cryptomator`. As pointed out by @infeo: 1. The vault is unlocked on app start, not during the OS startup. 2. A vault can only be unlocked if Cryptomator is running. Hence, it cannot be already unlocked.
Adds descriptions of general vault options, allowing people to read about options not shown in the screenshot (After successful unlock options) and learn how to rename a vault.