Skip to content

Consolidate encrypted file name docs and add video walkthrough#138

Open
mindmonk wants to merge 1 commit intodevelopfrom
feature/reoder-encrypted-file-names
Open

Consolidate encrypted file name docs and add video walkthrough#138
mindmonk wants to merge 1 commit intodevelopfrom
feature/reoder-encrypted-file-names

Conversation

@mindmonk
Copy link
Copy Markdown
Contributor

  • Moved the Locate Encrypted File section from accessing-vaults.md into encrypted-file-names.md, where it fits thematically
  • Added a Video Walkthrough section at the end of encrypted-file-names.md demonstrating both features in sequence
  • Replaced the full content in accessing-vaults.md#locate-encrypted-file with a short redirect link to the new location (preserving the anchor for any existing deep links)

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Walkthrough

This PR relocates documentation content for the "Locate Encrypted File" feature. The full description, step-by-step instructions, drag-and-drop guidance, and embedded video are removed from docs/desktop/accessing-vaults.md (14 lines removed) and consolidated into docs/desktop/encrypted-file-names.md (21 lines added). The original location is replaced with a cross-reference pointing readers to the new consolidated section, which now includes both the feature instructions and a video walkthrough demonstrating "Locate Encrypted File" and "Decrypt File Name" together.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • infeo
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: consolidating documentation about encrypted file names and adding a video walkthrough as described in the changeset.
Description check ✅ Passed The description is directly related to the changeset, explaining the specific file movements and additions (moving Locate Encrypted File section and adding Video Walkthrough).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/reoder-encrypted-file-names

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 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/encrypted-file-names.md`:
- Line 48: Update the phrase "third party app" in the Locate Encrypted File
feature description to "third-party app" to use the correct compound adjective;
locate the string in the docs line containing "Locate Encrypted File feature" or
the exact text "then restore an older version of the encrypted file with the
third party app" and replace it with the hyphenated form.
- Around line 87-89: The <video> block uses a .mov source but declares
type="video/mp4"; convert the file /vid/file-names.mov to an MP4 (H.264/AAC) and
update the <source> element to point to /vid/file-names.mp4 while keeping
type="video/mp4" so browsers (Chrome/Edge) correctly detect the MIME type;
locate the <video> tag and its <source> element in the doc and replace only the
file extension/URI to .mp4.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c8f01b89-745a-4564-8fb0-d1a6cbfa05a9

📥 Commits

Reviewing files that changed from the base of the PR and between bba87b1 and 282e865.

⛔ Files ignored due to path filters (1)
  • static/vid/file-names.mov is excluded by !**/*.mov
📒 Files selected for processing (2)
  • docs/desktop/accessing-vaults.md
  • docs/desktop/encrypted-file-names.md


## Locate Encrypted File {#locate-encrypted-file}

The Locate Encrypted File feature helps users find the encrypted version of a specific file. This feature is particularly useful when vault files are versioned and the user wants to restore an older version of a file. As Cryptomator encrypts filenames and obfuscates directory structures, users first locate the encrypted file and then restore an older version of the encrypted file with the third party app.
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.

⚠️ Potential issue | 🟡 Minor

Hyphenate “third-party” for correct compound adjective usage.

Please change “third party app” to “third-party app” for grammar consistency.

🧰 Tools
🪛 LanguageTool

[grammar] ~48-~48: Use a hyphen to join words.
Context: ...ion of the encrypted file with the third party app. 1. Unlock the desired vault....

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/desktop/encrypted-file-names.md` at line 48, Update the phrase "third
party app" in the Locate Encrypted File feature description to "third-party app"
to use the correct compound adjective; locate the string in the docs line
containing "Locate Encrypted File feature" or the exact text "then restore an
older version of the encrypted file with the third party app" and replace it
with the hyphenated form.

Comment on lines +87 to +89
<video controls autoplay loop muted style={{width: '100%', maxWidth: '1280px', height: 'auto'}}>
<source src="/vid/file-names.mov" type="video/mp4" />
Your browser does not support the video tag.
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.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🌐 Web query:

For an HTML5 <video><source>, what MIME type should be used for a .mov file, and what are browser compatibility implications versus .mp4 (H.264/AAC)?

💡 Result:

The standard MIME type for a .mov file (QuickTime container) is video/quicktime. However, video/quicktime has very limited browser support in HTML5

Citations:


🏁 Script executed:

#!/bin/bash

# Search for the video file reference in the docs directory
echo "=== Searching for video file references ==="
rg "file-names\.mov" docs/ 2>/dev/null || echo "No direct .mov references found"

# Check if assets directory exists and what's in vid directory
echo -e "\n=== Checking for vid directory ==="
find . -type d -name "vid" 2>/dev/null | head -20

# Search for any video file references in the repository
echo -e "\n=== Searching for any video file references ==="
rg "\.mov|\.mp4" docs/ --type md | head -20

# Check the exact file that was changed
echo -e "\n=== Checking the documentation file ==="
if [ -f "docs/desktop/encrypted-file-names.md" ]; then
  sed -n '83,90p' docs/desktop/encrypted-file-names.md
fi

Repository: cryptomator/docs

Length of output: 1003


Fix media type mismatch: convert .mov to .mp4.

The video file is a .mov file but declared as type="video/mp4". While .mov files with H.264/AAC codecs may play in Safari and Firefox, they will fail silently in Chrome and Edge (which enforce strict MIME checking). Convert the file to .mp4 format and keep type="video/mp4" for universal browser support across all modern browsers.

Alternatively, use type="video/quicktime" for the .mov file, but this has very limited browser support and is not recommended for production documentation.

Recommended fix: convert to .mp4
-  <source src="/vid/file-names.mov" type="video/mp4" />
+  <source src="/vid/file-names.mp4" type="video/mp4" />
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/desktop/encrypted-file-names.md` around lines 87 - 89, The <video> block
uses a .mov source but declares type="video/mp4"; convert the file
/vid/file-names.mov to an MP4 (H.264/AAC) and update the <source> element to
point to /vid/file-names.mp4 while keeping type="video/mp4" so browsers
(Chrome/Edge) correctly detect the MIME type; locate the <video> tag and its
<source> element in the doc and replace only the file extension/URI to .mp4.

@mindmonk mindmonk requested a review from infeo March 30, 2026 10:50
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.

1 participant