Desktop release 1.16.0 #81
Conversation
WalkthroughThis update introduces several changes and additions to the Cryptomator desktop documentation. A new image is used in the "Accessing Vaults" section, replacing the previous illustration of an unlocked vault. Two new documentation files are added: "encrypted-file-names.rst," which details how Cryptomator encrypts file and directory names and explains the "Decrypt file name" feature, and "vault-events.rst," which describes the vault events system and the event view accessible in the desktop application. The "Sync Conflicts" documentation is expanded to clarify how synchronization conflicts for encrypted files are handled, including examples and a detailed table of conflict suffixes. The documentation index is updated to include the two new files in the desktop section, integrating them into the navigation structure. No changes to code, public APIs, or exported entities are included in this update. Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
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:
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: 3
🔭 Outside diff range comments (1)
source/desktop/sync-conflicts.rst (1)
54-56:⚠️ Potential issueExample file extension mismatch
The new decrypted filename example ends with.c9rin the text but refers to.docin the sentence. Please verify and correct the file extension to match the original.
🧹 Nitpick comments (10)
source/desktop/vault-events.rst (3)
1-7: Section title review
The heading “Events and Event View” and its underline length are correctly matched. Consider whether “Event View” should be pluralized to “Events and Event Views” for consistency with the title, or leave singular if it refers to the feature name.
28-32: Filtering and clearing instructions
These usage steps are clear. Optionally, you could mention any available keyboard shortcuts for filtering or clearing the log if the application supports them.
34-45: Vault Event details
The “Vault Event” sub-section describes event components well. For consistency, consider rephrasing “If you hover over the event” to “When hovering over an event” to align with style guidelines.source/desktop/sync-conflicts.rst (5)
4-5: Tone and clarity
The opening sentence is lengthy. Consider condensing to something like:
“Encrypted files sync across locations just like unencrypted files, so conflicts are handled in the same way.”
29-33: Grammar and phrasing
Replace “cloud storages” with “cloud storage providers” or “in cloud storage” to correct the terminology.
38-42: List indentation
The numbered list under “Handling Sync Conflicts” starts at the margin. Indenting the list by at least one space will improve readability under the section header.
48-49: Example clarity
You may want to note that the encrypted filename in this example is truncated (e.g., with “…”) for brevity, to avoid confusion about actual filename lengths.
51-53: Term usage consistency
Here you revert to “sync conflict.” Consider standardizing on one term—either “sync conflict” or “synchronization conflict”—across the entire document.source/desktop/encrypted-file-names.rst (2)
8-18: Original directory tree code block
The example is clear and properly indented. You could add a brief caption or inline comment to clarify that this shows the user-facing directory structure.
19-37: Encrypted directory structure code block
Ensure that any asterisks (*) in the encrypted filenames aren’t interpreted as emphasis by Sphinx. If needed, escape them or use a literal “::” directive.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
source/img/desktop/decrypt-file-names.pngis excluded by!**/*.pngsource/img/desktop/event-view.pngis excluded by!**/*.pngsource/img/desktop/vault-detail-unlocked-simple.pngis excluded by!**/*.pngsource/img/desktop/vault-detail-unlocked.pngis excluded by!**/*.png
📒 Files selected for processing (5)
source/desktop/accessing-vaults.rst(1 hunks)source/desktop/encrypted-file-names.rst(1 hunks)source/desktop/sync-conflicts.rst(2 hunks)source/desktop/vault-events.rst(1 hunks)source/index.rst(1 hunks)
🔇 Additional comments (11)
source/desktop/accessing-vaults.rst (2)
58-58: Verify new image asset exists
Ensure that../img/desktop/vault-detail-unlocked-simple.pngwas included in this PR and that the path is correct so the updated illustration renders properly.
59-59: Alt text remains appropriate
The existing alt text “Cryptomator window showing an unlocked vault” still accurately describes the new image. No change needed.source/index.rst (2)
28-28: Verify inclusion ofencrypted-file-names.rst
Please confirm thatsource/desktop/encrypted-file-names.rstexists in the repository so it appears correctly in the desktop toctree.
30-30: Verify inclusion ofvault-events.rst
Ensure thatsource/desktop/vault-events.rstwas added and is referenced here in the desktop section.source/desktop/vault-events.rst (2)
8-12: Note directive styling
The note about non-persistence is clear and correctly indented under the.. note::directive. No changes are required here.
14-26: Event View section completeness
The “Event View” description is concise and the image reference is properly formatted. Please verify that../img/desktop/event-view.pngis present in the static assets.source/desktop/encrypted-file-names.rst (5)
1-7: Title and note formatting
The section title and its underline match in length, and the note directive is correctly formatted. Excellent!
43-51: Decrypting File Names section
The anchor, heading, and underline lengths are all correct, and the instructional text is clear. No changes needed.
53-59: First decryption-flow image
Verify that../img/desktop/vault-detail-unlocked.pngis present and that the alt text “Vault detail view in the unlocked state” accurately describes the screenshot.
64-68: Decrypt file names window image
The:alt:,:scale:, and:align:options look good. Confirm that../img/desktop/decrypt-file-names.pngrenders at the intended size and alignment.
69-74: Final usage notes
The guidance on selecting and copying cells is concise and clear. No further edits are required.
Adjust some documentation to the new desktop release 1.16.0.
Notable changes: