Skip to content

Consolidate encrypted file name docs and add video walkthrough#138

Open
mindmonk wants to merge 4 commits intodevelopfrom
feature/reoder-encrypted-file-names
Open

Consolidate encrypted file name docs and add video walkthrough#138
mindmonk wants to merge 4 commits 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 removes the detailed "Locate Encrypted File" instructions from docs/desktop/accessing-vaults.md and replaces them with a cross-reference to the new subsection added to docs/desktop/encrypted-file-names.md. The encrypted-file-names page now contains a "Locate Encrypted File" section, updated "Decrypt File Name" instructions, and an embedded video walkthrough demonstrating both features.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: consolidating encrypted file documentation and adding a video walkthrough.
Description check ✅ Passed The description is directly related to the changeset, clearly explaining the three key changes made across the two documentation files.
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

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
Copy link
Copy Markdown
Member

@infeo infeo left a comment

Choose a reason for hiding this comment

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

nice video. But the writing should be adjusted to be less copy-paste.

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.

♻️ Duplicate comments (2)
docs/desktop/encrypted-file-names.md (2)

49-49: ⚠️ Potential issue | 🟡 Minor

Hyphenate compound adjective at Line 49.

“third party app” should be “third-party app” for correct usage and consistency.

🤖 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 49, The sentence describing the
Locate Encrypted File feature uses an unhyphenated compound adjective—replace
the phrase "third party app" with "third-party app" in the document (look for
the sentence starting "The Locate Encrypted File feature helps users..." and the
phrase "third party app") to correct the compound adjective usage and match
style/consistency.

90-91: ⚠️ Potential issue | 🟠 Major

Fix video container/type mismatch at Lines 90-91.

The source points to .mov while declaring type="video/mp4". Use an actual .mp4 asset with video/mp4, or declare the correct MIME for .mov (less compatible).

For HTML5 <video>, what is the correct MIME type for a .mov file, and what is cross-browser support compared to .mp4 (H.264/AAC)?
Proposed fix
-  <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 90 - 91, The video tag is
mismatched: the <source> uses src="/vid/file-names.mov" but type="video/mp4";
update the asset or MIME so they match—either replace the .mov with a proper
.mp4 asset and keep type="video/mp4" (recommended for broad H.264/AAC browser
support), or change the type to "video/quicktime" to match the .mov (note: .mov
has poorer cross-browser support). Locate the <video> block and the <source
src="/vid/file-names.mov" type="video/mp4" /> entry and make the appropriate
change so src and type agree.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/desktop/encrypted-file-names.md`:
- Line 49: The sentence describing the Locate Encrypted File feature uses an
unhyphenated compound adjective—replace the phrase "third party app" with
"third-party app" in the document (look for the sentence starting "The Locate
Encrypted File feature helps users..." and the phrase "third party app") to
correct the compound adjective usage and match style/consistency.
- Around line 90-91: The video tag is mismatched: the <source> uses
src="/vid/file-names.mov" but type="video/mp4"; update the asset or MIME so they
match—either replace the .mov with a proper .mp4 asset and keep type="video/mp4"
(recommended for broad H.264/AAC browser support), or change the type to
"video/quicktime" to match the .mov (note: .mov has poorer cross-browser
support). Locate the <video> block and the <source src="/vid/file-names.mov"
type="video/mp4" /> entry and make the appropriate change so src and type agree.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 622e4023-7fcc-4080-b6bd-dd0b359ecfa0

📥 Commits

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

📒 Files selected for processing (1)
  • docs/desktop/encrypted-file-names.md

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.

♻️ Duplicate comments (1)
docs/desktop/encrypted-file-names.md (1)

90-92: ⚠️ Potential issue | 🟠 Major

CRITICAL: Unresolved browser compatibility issue with .mov file.

This major issue was previously flagged but remains unaddressed. The video source uses a .mov file but declares type="video/mp4". This mismatch will cause silent playback failures in Chrome and Edge browsers, which enforce strict MIME type checking. Users on these browsers won't see the video walkthrough.

Required action: Convert /vid/file-names.mov to MP4 format (H.264/AAC) for universal browser support.

🔧 Required fix
-  <source src="/vid/file-names.mov" type="video/mp4" />
+  <source src="/vid/file-names.mp4" type="video/mp4" />

After applying this diff, convert the actual video file from .mov to .mp4 format.

As per past review: "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)."

🤖 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 90 - 92, The <video>
element references a .mov file while declaring type="video/mp4", causing MIME
mismatch; convert the actual media file at '/vid/file-names.mov' to an MP4
(H.264 video / AAC audio), replace the source filename to the resulting .mp4 and
ensure the <source> element's type is video/mp4 so the <video> tag and <source>
(src="/vid/file-names.mov") are consistent and browser-compatible; after
conversion verify playback in Chrome/Edge and update any asset build/process
that serves the file.
🧹 Nitpick comments (1)
docs/desktop/encrypted-file-names.md (1)

62-62: Optional: Consider rewording to avoid "only" repetition.

The phrase "given only an encrypted file Cryptomator can only decrypt" uses "only" twice in close proximity, which creates slight awkwardness. Consider a minor rephrase for clarity:

♻️ Suggested rewording
-Due to technical reasons, given only an encrypted file Cryptomator can only decrypt its name.
+Due to technical reasons, when given just an encrypted file, Cryptomator can only decrypt its name.

As per static analysis hint: "This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym."

🤖 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 62, The sentence "Due to
technical reasons, given only an encrypted file Cryptomator can only decrypt its
name." repeats "only" and reads awkwardly; reword it to remove the duplicate
adverb—for example, change the clause to "Given an encrypted file, Cryptomator
can only decrypt its name" or "Due to technical reasons, Cryptomator can decrypt
only the filename when given an encrypted file." Update the sentence in
encrypted-file-names.md accordingly to preserve meaning while eliminating the
double "only."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/desktop/encrypted-file-names.md`:
- Around line 90-92: The <video> element references a .mov file while declaring
type="video/mp4", causing MIME mismatch; convert the actual media file at
'/vid/file-names.mov' to an MP4 (H.264 video / AAC audio), replace the source
filename to the resulting .mp4 and ensure the <source> element's type is
video/mp4 so the <video> tag and <source> (src="/vid/file-names.mov") are
consistent and browser-compatible; after conversion verify playback in
Chrome/Edge and update any asset build/process that serves the file.

---

Nitpick comments:
In `@docs/desktop/encrypted-file-names.md`:
- Line 62: The sentence "Due to technical reasons, given only an encrypted file
Cryptomator can only decrypt its name." repeats "only" and reads awkwardly;
reword it to remove the duplicate adverb—for example, change the clause to
"Given an encrypted file, Cryptomator can only decrypt its name" or "Due to
technical reasons, Cryptomator can decrypt only the filename when given an
encrypted file." Update the sentence in encrypted-file-names.md accordingly to
preserve meaning while eliminating the double "only."

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e86888a4-ddc1-4542-b972-98257fae29c5

📥 Commits

Reviewing files that changed from the base of the PR and between 8402029 and 3aaad72.

📒 Files selected for processing (1)
  • docs/desktop/encrypted-file-names.md

@mindmonk mindmonk requested a review from infeo April 1, 2026 07:14
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.

♻️ Duplicate comments (1)
docs/desktop/encrypted-file-names.md (1)

90-91: ⚠️ Potential issue | 🟠 Major

Unresolved media source/type mismatch in video embed.

The source is .mov while declared as type="video/mp4". This can break playback in some browsers; use a real .mp4 source (preferred) or declare QuickTime MIME explicitly.

Recommended fix
-  <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 90 - 91, The video embed
has a mismatched source and MIME type: the <source> element uses
src="/vid/file-names.mov" but type="video/mp4"; update the embed so the src
points to a real .mp4 file (preferred) or change the type to the QuickTime MIME
("video/quicktime") to match .mov, editing the <video> / <source> elements in
the markup (look for the video tag and its source element) to ensure src and
type are consistent.
🧹 Nitpick comments (1)
docs/desktop/encrypted-file-names.md (1)

49-49: Consider replacing colloquial phrasing for consistency.

“comes in handy” is a bit informal compared to the surrounding style; a more neutral phrasing would better match the rest of the page.

Suggested wording
-The Locate Encrypted File feature helps you find the encrypted version of a specific file from inside the vault. This comes in handy when vault files are versioned and you want to restore an older version of a file.
+The Locate Encrypted File feature helps you find the encrypted version of a specific file from inside the vault. This is useful when vault files are versioned and you want to restore an older version of a file.
🤖 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 49, Replace the informal phrase
"comes in handy" in the sentence describing the Locate Encrypted File feature
with a more neutral alternative (e.g., "is useful" or "can be helpful") to match
the document's tone; update the sentence in docs/desktop/encrypted-file-names.md
where the Locate Encrypted File feature is described so it reads something like
"This is useful when vault files are versioned and you want to restore an older
version of a file," ensuring surrounding punctuation and flow remain correct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/desktop/encrypted-file-names.md`:
- Around line 90-91: The video embed has a mismatched source and MIME type: the
<source> element uses src="/vid/file-names.mov" but type="video/mp4"; update the
embed so the src points to a real .mp4 file (preferred) or change the type to
the QuickTime MIME ("video/quicktime") to match .mov, editing the <video> /
<source> elements in the markup (look for the video tag and its source element)
to ensure src and type are consistent.

---

Nitpick comments:
In `@docs/desktop/encrypted-file-names.md`:
- Line 49: Replace the informal phrase "comes in handy" in the sentence
describing the Locate Encrypted File feature with a more neutral alternative
(e.g., "is useful" or "can be helpful") to match the document's tone; update the
sentence in docs/desktop/encrypted-file-names.md where the Locate Encrypted File
feature is described so it reads something like "This is useful when vault files
are versioned and you want to restore an older version of a file," ensuring
surrounding punctuation and flow remain correct.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5385498f-6df0-4ed9-9852-f18ca6ff4028

📥 Commits

Reviewing files that changed from the base of the PR and between 3aaad72 and 25c1932.

📒 Files selected for processing (1)
  • docs/desktop/encrypted-file-names.md

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.

2 participants