Open
Conversation
Contributor
WalkthroughThis pull request comprehensively updates the documentation build system and content structure. The changes include converting heading anchor syntax across ~40 MDX files from Estimated code review effort🎯 3 (Moderate) | ⏱️ ~40 minutes Possibly related PRs
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 docstrings
🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 9
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/desktop/setup.mdx (2)
9-9:⚠️ Potential issue | 🟡 MinorRemove trailing whitespace on this line.
Line 9 ends with an extra trailing space after the period (“Linux. ”). In stricter doc/MDX linting setups, trailing whitespace can cause failures.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/desktop/setup.mdx` at line 9, Remove the trailing whitespace at the end of the sentence "The Desktop version of Cryptomator is currently available for Windows, macOS, and Linux." in the docs/desktop/setup.mdx file so the line ends with "Linux." (no extra space); locate the exact string in the file and trim the trailing space to satisfy MDX/markdown linting.
41-41:⚠️ Potential issue | 🟡 MinorRemove trailing whitespace on this line.
Line 41 ends with an extra trailing space after “distributions.” (“distributions. ”). Please trim it to avoid formatting/lint noise.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/desktop/setup.mdx` at line 41, Remove the trailing whitespace at the end of the sentence that begins "The easiest and recommended way of installing Cryptomator on Linux is by downloading Cryptomator's AppImage (an `.appimage` file) - as it works on almost all distributions." in docs/desktop/setup.mdx by editing that line and deleting the extra space after "distributions." so the line ends cleanly with the period.
🧹 Nitpick comments (1)
docs/android/vault-management.mdx (1)
35-35: Use relative file links instead of/docs/...paths for portability.Docusaurus documentation explicitly marks
/docs/...links as less portable, requiring manual updates if you create new doc versions or localize the docs. Use relative file paths (e.g.,../path/file.mdx) instead, which automatically resolve to the correct version-specific and locale-specific URLs.Also applies to: 67-67, 93-93, 162-162
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/android/vault-management.mdx` at line 35, Replace the absolute /docs/... link with a relative file link so it resolves correctly for versions and locales: locate the link text "Cloud Services With WebDAV Support" that currently points to /docs/misc/supported-cloud-services.mdx#cloud-services-with-webdav-support and change it to a relative path (for example ../misc/supported-cloud-services.mdx#cloud-services-with-webdav-support). Do the same replacement for the other occurrences mentioned (lines referencing the same supported-cloud-services.mdx target) so all links use the relative ../misc/... path instead of the leading /docs/.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/update-windows-info.yml:
- Line 67: Update the workflow to reference the correct file name
verify-installers.mdx everywhere it currently uses verify-installers.md: change
the workflow name string, the step name that mentions the document, the $DocPath
assignment (set to verify-installers.mdx), both error message strings that
mention the .md filename, and the git stage command to stage
verify-installers.mdx instead of the .md file so all steps (step names, $DocPath
variable, error messages, and the git add/git stage invocation) consistently
point to verify-installers.mdx.
In `@docs/desktop/password-and-recovery-key.mdx`:
- Line 17: The sentence "It is a human readable form of your decrypted
[masterkey]..." should use a hyphenated compound adjective; change "human
readable" to "human-readable" so it reads "It is a human-readable form of your
decrypted [masterkey]..." to improve correctness and consistency.
In `@docs/desktop/setup.mdx`:
- Line 17: Remove the trailing spaces at the ends of the two lines that end with
"Linux." and "distributions." in the document (the section headed "## Install
Cryptomator on Windows {/* `#install-cryptomator-on-windows` */}"); open the file,
delete the extra space characters after those words so the lines end cleanly,
and save the file (or run a trim-whitespace formatter to ensure no other
trailing spaces remain).
In `@docs/hub/access-vault.mdx`:
- Line 34: Replace the ungrammatical phrase "If you just did setup your account,
a vault owner needs to grant you access for the requested vault..." with correct
wording such as "If you have just set up your account, a vault owner needs to
grant you access for the requested vault as described
[here](vault-management.mdx#update-permissions). Retry unlocking the vault after
the vault owner grants you access." Locate and update the sentence that begins
"If you just did setup your account..." in docs/hub/access-vault.mdx (the
sentence text is a unique identifier) to use "have just set up" or "just set up"
and adjust verb tense consistency ("grants" instead of "granted") as shown.
In `@docs/hub/deployment.mdx`:
- Line 23: Replace the incorrect verb form "login" with the phrasal verb "log
in" in the sentence shown (the string "You can now login to Cryptomator Hub and
start [creating vaults](vault-management.mdx) or [add
users](user-group-management.mdx)."); update it to "You can now log in to
Cryptomator Hub and start ..." so the user-facing docs use the correct verb
form.
In `@docs/hub/vault-management.mdx`:
- Line 75: Update the phrase "human readable form of the vault [masterkey]" to
use the hyphenated compound adjective "human-readable" so it reads
"human-readable form of the vault [masterkey]"; locate the exact sentence in the
docs where the string "human readable form of the vault [masterkey]" appears (in
the vault-management.mdx content) and replace with "human-readable" to correct
the grammar.
In `@docs/misc/supported-cloud-services.mdx`:
- Line 52: Change the user-facing phrase "so called" to the hyphenated
"so-called" in the footnote text identified by the marker [^file-providers] (the
sentence starting "Some Android and iOS apps integrate into the operating
system's file manager... to allow seamless access to their files via so called
"File Providers."). Update that occurrence to "so-called" so the documentation
uses correct hyphenation.
In `@docs/security/architecture.mdx`:
- Line 77: Fix the typo in the user-facing sentence that reads "the encrypted
raw masterkey can be retrieved from a the server component" by removing the
extraneous "a" so it reads "the encrypted raw masterkey can be retrieved from
the server component"; edit the sentence in docs/security/architecture.mdx
accordingly.
- Line 77: Fix the typo in docs/security/architecture.mdx where the sentence
"When using [Cryptomator Hub](/docs/hub/access-vault.mdx), the encrypted raw
masterkey can be retrieved from a the server component." contains "from a the";
change it to "from the" so the sentence reads "...can be retrieved from the
server component." Reference the sentence containing "encrypted raw masterkey"
to locate the change.
---
Outside diff comments:
In `@docs/desktop/setup.mdx`:
- Line 9: Remove the trailing whitespace at the end of the sentence "The Desktop
version of Cryptomator is currently available for Windows, macOS, and Linux." in
the docs/desktop/setup.mdx file so the line ends with "Linux." (no extra space);
locate the exact string in the file and trim the trailing space to satisfy
MDX/markdown linting.
- Line 41: Remove the trailing whitespace at the end of the sentence that begins
"The easiest and recommended way of installing Cryptomator on Linux is by
downloading Cryptomator's AppImage (an `.appimage` file) - as it works on almost
all distributions." in docs/desktop/setup.mdx by editing that line and deleting
the extra space after "distributions." so the line ends cleanly with the period.
---
Nitpick comments:
In `@docs/android/vault-management.mdx`:
- Line 35: Replace the absolute /docs/... link with a relative file link so it
resolves correctly for versions and locales: locate the link text "Cloud
Services With WebDAV Support" that currently points to
/docs/misc/supported-cloud-services.mdx#cloud-services-with-webdav-support and
change it to a relative path (for example
../misc/supported-cloud-services.mdx#cloud-services-with-webdav-support). Do the
same replacement for the other occurrences mentioned (lines referencing the same
supported-cloud-services.mdx target) so all links use the relative ../misc/...
path instead of the leading /docs/.
🪄 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: 992e4e75-1dce-44b5-bc84-424b9cf6f5be
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (57)
.github/workflows/update-windows-info.ymldocs/android/access-vault.mdxdocs/android/cloud-management.mdxdocs/android/index.mdxdocs/android/settings.mdxdocs/android/setup.mdxdocs/android/vault-management.mdxdocs/desktop/accessing-vaults.mdxdocs/desktop/adding-vaults.mdxdocs/desktop/admin-config.mdxdocs/desktop/common-errors.mdxdocs/desktop/encrypted-file-names.mdxdocs/desktop/error-handling.mdxdocs/desktop/files-in-use.mdxdocs/desktop/getting-started.mdxdocs/desktop/index.mdxdocs/desktop/network.mdxdocs/desktop/password-and-recovery-key.mdxdocs/desktop/setup.mdxdocs/desktop/sync-conflicts.mdxdocs/desktop/troubleshooting.mdxdocs/desktop/vault-events.mdxdocs/desktop/vault-management.mdxdocs/desktop/vault-recovery.mdxdocs/desktop/volume-type.mdxdocs/hub/access-vault.mdxdocs/hub/admin.mdxdocs/hub/deployment.mdxdocs/hub/early-access.mdxdocs/hub/emergency-access.mdxdocs/hub/index.mdxdocs/hub/introduction.mdxdocs/hub/user-group-management.mdxdocs/hub/vault-management.mdxdocs/hub/vault-recovery.mdxdocs/hub/your-account.mdxdocs/ios/access-vault.mdxdocs/ios/cloud-management.mdxdocs/ios/index.mdxdocs/ios/settings.mdxdocs/ios/setup.mdxdocs/ios/shortcuts-guide.mdxdocs/ios/vault-management.mdxdocs/misc/contribute.mdxdocs/misc/index.mdxdocs/misc/manual-migration.mdxdocs/misc/supported-cloud-services.mdxdocs/misc/vault-format-history.mdxdocs/security/architecture.mdxdocs/security/best-practices.mdxdocs/security/hub.mdxdocs/security/index.mdxdocs/security/security-target.mdxdocs/security/vault.mdxdocs/security/verify-installers.mdxdocusaurus.config.tspackage.json
| Set-Content -Path $DocPath -Value $Content | ||
| env: | ||
| AUTOMATION_MARKER: '<!-- AUTOMATION MARKER FOR WORKFLOW -->' | ||
| AUTOMATION_MARKER: '{/* AUTOMATION MARKER FOR WORKFLOW */}' |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify which verify-installers file exists and what path the workflow uses.
fd -a '^verify-installers\.(md|mdx)$' docs/security
rg -n -C2 'verify-installers\.(md|mdx)' .github/workflows/update-windows-info.ymlRepository: cryptomator/docs
Length of output: 1571
Update workflow to reference verify-installers.mdx instead of .md.
The file exists as verify-installers.mdx but the workflow references verify-installers.md in multiple locations (lines 1, 41, 46, 52, 58, 74). The workflow will fail when attempting to read or write the non-existent .md file.
Update all references:
- Line 1: Workflow name
- Line 41: Step name
- Line 46:
$DocPathvariable assignment - Line 52 & 58: Error messages
- Line 74:
git stagecommand
Proposed fix
-name: Updates verify-installers.md after desktop release
+name: Updates verify-installers.mdx after desktop release
- - name: Update verify-installers.md
+ - name: Update verify-installers.mdx
shell: pwsh
run: |
$Thumbprint = (Get-AuthenticodeSignature -FilePath 'cryptomator.msi' -ErrorAction Stop).SignerCertificate.Thumbprint
- $DocPath = 'docs/security/verify-installers.md'
+ $DocPath = 'docs/security/verify-installers.mdx'
$Content = Get-Content -Path $DocPath -Raw
$UpdatedContent = $CurrentThumbprintRegex.Replace($Content, ($env:AUTOMATION_MARKER + '`' + $Thumbprint + '`'), 1)
if ($UpdatedContent -eq $Content) {
- throw 'Failed to update the current Windows thumbprint in verify-installers.md.'
+ throw 'Failed to update the current Windows thumbprint in verify-installers.mdx.'
}
$Content = $UpdatedContent
$MarkedRow = (Get-Content -Path $DocPath | Where-Object { $_.TrimStart().StartsWith('|') -and $_.Contains($env:AUTOMATION_MARKER) } | Select-Object -First 1)
if ($null -eq $MarkedRow) {
- throw 'Failed to find the marked Windows certificate table row in verify-installers.md.'
+ throw 'Failed to find the marked Windows certificate table row in verify-installers.mdx.'
}
- git stage docs/security/verify-installers.md
+ git stage docs/security/verify-installers.mdx🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/workflows/update-windows-info.yml at line 67, Update the workflow to
reference the correct file name verify-installers.mdx everywhere it currently
uses verify-installers.md: change the workflow name string, the step name that
mentions the document, the $DocPath assignment (set to verify-installers.mdx),
both error message strings that mention the .md filename, and the git stage
command to stage verify-installers.mdx instead of the .md file so all steps
(step names, $DocPath variable, error messages, and the git add/git stage
invocation) consistently point to verify-installers.mdx.
| A *recovery key* allows you to create a new password if you forget the original one. | ||
| Do note that the *recovery key* feature does not break encryption in any way. | ||
| It is a human readable form of your decrypted [masterkey](/docs/security/architecture.md#masterkey) and therefore independent of the current vault password and highly confidential. | ||
| It is a human readable form of your decrypted [masterkey](/docs/security/architecture.mdx#masterkey) and therefore independent of the current vault password and highly confidential. |
Contributor
There was a problem hiding this comment.
Hyphenate compound adjective in Line 17 (“human-readable”).
This improves correctness and consistency in technical writing.
✏️ Proposed edit
-It is a human readable form of your decrypted [masterkey](/docs/security/architecture.mdx#masterkey) and therefore independent of the current vault password and highly confidential.
+It is a human-readable form of your decrypted [masterkey](/docs/security/architecture.mdx#masterkey) and therefore independent of the current vault password and highly confidential.📝 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.
Suggested change
| It is a human readable form of your decrypted [masterkey](/docs/security/architecture.mdx#masterkey) and therefore independent of the current vault password and highly confidential. | |
| It is a human-readable form of your decrypted [masterkey](/docs/security/architecture.mdx#masterkey) and therefore independent of the current vault password and highly confidential. |
🧰 Tools
🪛 LanguageTool
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...eak encryption in any way. It is a human readable form of your decrypted [masterk...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/desktop/password-and-recovery-key.mdx` at line 17, The sentence "It is a
human readable form of your decrypted [masterkey]..." should use a hyphenated
compound adjective; change "human readable" to "human-readable" so it reads "It
is a human-readable form of your decrypted [masterkey]..." to improve
correctness and consistency.
| ::: | ||
|
|
||
| ## Install Cryptomator on Windows {#install-cryptomator-on-windows} | ||
| ## Install Cryptomator on Windows {/* #install-cryptomator-on-windows */} |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify heading anchor ID usage and ensure old syntax isn't lingering.
set -euo pipefail
# 1) Find all occurrences of the new anchor IDs.
rg -n --hidden 'install-cryptomator-on-(windows|macos|linux)' docs
# 2) Check for lingering old-style explicit heading anchors `{#...}`.
rg -n --hidden '\{`#install-cryptomator-on-`(windows|macos|linux)\}' docs
# 3) (Optional) Confirm that headings now contain the JSX comment anchor pattern.
rg -n --hidden '## Install Cryptomator on (Windows|macOS|Linux)\s*\{\*/\#install-cryptomator-on-' docsRepository: cryptomator/docs
Length of output: 352
🏁 Script executed:
# Check the full context of lines around the changes to verify trailing whitespace claims
head -45 docs/desktop/setup.mdx | tail -40 | cat -ARepository: cryptomator/docs
Length of output: 2263
🏁 Script executed:
# Search for any links or references to these anchors in other documentation files
rg -n 'install-cryptomator-on-(windows|macos|linux)' docs --type mdx --type md | grep -v '^docs/desktop/setup.mdx'Repository: cryptomator/docs
Length of output: 88
🏁 Script executed:
# Search for references to these anchor IDs across all docs without file type restrictions
rg -n 'install-cryptomator-on-(windows|macos|linux)' docs | grep -v '^docs/desktop/setup.mdx:' || echo "No external references found"Repository: cryptomator/docs
Length of output: 89
Remove trailing whitespace on lines 9 and 41.
Line 9 ends with a space after "Linux." and line 41 ends with a space after "distributions." These trailing spaces should be removed.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/desktop/setup.mdx` at line 17, Remove the trailing spaces at the ends of
the two lines that end with "Linux." and "distributions." in the document (the
section headed "## Install Cryptomator on Windows {/*
`#install-cryptomator-on-windows` */}"); open the file, delete the extra space
characters after those words so the lines end cleanly, and save the file (or run
a trim-whitespace formatter to ensure no other trailing spaces remain).
| ### 3. Register Device {/* #register-device */} | ||
|
|
||
| If you just did setup your account, a vault owner needs to grant you access for the requested vault as described [here](vault-management.md#update-permissions). Retry unlocking the vault after the vault owner granted you access. | ||
| If you just did setup your account, a vault owner needs to grant you access for the requested vault as described [here](vault-management.mdx#update-permissions). Retry unlocking the vault after the vault owner granted you access. |
Contributor
There was a problem hiding this comment.
Fix grammar in Line 34 (“set up” vs. “did setup”).
Current phrasing is ungrammatical in user-facing text.
✏️ Proposed edit
-If you just did setup your account, a vault owner needs to grant you access for the requested vault as described [here](vault-management.mdx#update-permissions). Retry unlocking the vault after the vault owner granted you access.
+If you just set up your account, a vault owner needs to grant you access for the requested vault as described [here](vault-management.mdx#update-permissions). Retry unlocking the vault after the vault owner granted you access.📝 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.
Suggested change
| If you just did setup your account, a vault owner needs to grant you access for the requested vault as described [here](vault-management.mdx#update-permissions). Retry unlocking the vault after the vault owner granted you access. | |
| If you just set up your account, a vault owner needs to grant you access for the requested vault as described [here](vault-management.mdx#update-permissions). Retry unlocking the vault after the vault owner granted you access. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/hub/access-vault.mdx` at line 34, Replace the ungrammatical phrase "If
you just did setup your account, a vault owner needs to grant you access for the
requested vault..." with correct wording such as "If you have just set up your
account, a vault owner needs to grant you access for the requested vault as
described [here](vault-management.mdx#update-permissions). Retry unlocking the
vault after the vault owner grants you access." Locate and update the sentence
that begins "If you just did setup your account..." in docs/hub/access-vault.mdx
(the sentence text is a unique identifier) to use "have just set up" or "just
set up" and adjust verb tense consistency ("grants" instead of "granted") as
shown.
|
|
||
| Afterwards you're done. | ||
| You can now login to Cryptomator Hub and start [creating vaults](vault-management.md) or [add users](user-group-management.md). | ||
| You can now login to Cryptomator Hub and start [creating vaults](vault-management.mdx) or [add users](user-group-management.mdx). |
Contributor
There was a problem hiding this comment.
Fix verb usage in Line 23: use “log in” instead of “login”.
This is a minor wording issue in user-facing docs.
✏️ Proposed edit
-You can now login to Cryptomator Hub and start [creating vaults](vault-management.mdx) or [add users](user-group-management.mdx).
+You can now log in to Cryptomator Hub and start [creating vaults](vault-management.mdx) or [add users](user-group-management.mdx).📝 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.
Suggested change
| You can now login to Cryptomator Hub and start [creating vaults](vault-management.mdx) or [add users](user-group-management.mdx). | |
| You can now log in to Cryptomator Hub and start [creating vaults](vault-management.mdx) or [add users](user-group-management.mdx). |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/hub/deployment.mdx` at line 23, Replace the incorrect verb form "login"
with the phrasal verb "log in" in the sentence shown (the string "You can now
login to Cryptomator Hub and start [creating vaults](vault-management.mdx) or
[add users](user-group-management.mdx)."); update it to "You can now log in to
Cryptomator Hub and start ..." so the user-facing docs use the correct verb
form.
| :::warning | ||
| The recovery key is **highly confidential**. | ||
| It is a human readable form of the vault [masterkey](/docs/security/architecture.md#masterkey), which is used to encrypt your data and independent of the key management in Cryptomator Hub. | ||
| It is a human readable form of the vault [masterkey](/docs/security/architecture.mdx#masterkey), which is used to encrypt your data and independent of the key management in Cryptomator Hub. |
Contributor
There was a problem hiding this comment.
Hyphenate compound adjective in Line 75 (“human-readable”).
Minor grammar fix for user-facing clarity.
✏️ Proposed edit
-It is a human readable form of the vault [masterkey](/docs/security/architecture.mdx#masterkey), which is used to encrypt your data and independent of the key management in Cryptomator Hub.
+It is a human-readable form of the vault [masterkey](/docs/security/architecture.mdx#masterkey), which is used to encrypt your data and independent of the key management in Cryptomator Hub.📝 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.
Suggested change
| It is a human readable form of the vault [masterkey](/docs/security/architecture.mdx#masterkey), which is used to encrypt your data and independent of the key management in Cryptomator Hub. | |
| It is a human-readable form of the vault [masterkey](/docs/security/architecture.mdx#masterkey), which is used to encrypt your data and independent of the key management in Cryptomator Hub. |
🧰 Tools
🪛 LanguageTool
[grammar] ~75-~75: Use a hyphen to join words.
Context: ...s highly confidential. It is a human readable form of the vault [masterkey](/...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/hub/vault-management.mdx` at line 75, Update the phrase "human readable
form of the vault [masterkey]" to use the hyphenated compound adjective
"human-readable" so it reads "human-readable form of the vault [masterkey]";
locate the exact sentence in the docs where the string "human readable form of
the vault [masterkey]" appears (in the vault-management.mdx content) and replace
with "human-readable" to correct the grammar.
| [^no-accrescent]: Not supported by the [Accrescent variant](/docs/android/setup.md#accrescent) because this Cloud Service requires proprietary dependencies. | ||
| [^no-accrescent]: Not supported by the [Accrescent variant](/docs/android/setup.mdx#accrescent) because this Cloud Service requires proprietary dependencies. | ||
|
|
||
| [^file-providers]: Some Android and iOS apps integrate into the operating system's file manager with their own storage spaces to allow seamless access to their files via so called "File Providers." Cryptomator generally supports saving vaults in those spaces, but is dependent on those apps explicitly supporting access by other apps like Cryptomator. For more technical information about this see [here](https://github.com/cryptomator/android/issues/553) for Android and [here](https://github.com/cryptomator/ios/issues/51) for iOS. |
Contributor
There was a problem hiding this comment.
Hyphenate “so-called” in user-facing text.
Line 52 currently uses “so called”, which should be hyphenated.
✍️ Suggested wording fix
-[^file-providers]: Some Android and iOS apps integrate into the operating system's file manager with their own storage spaces to allow seamless access to their files via so called "File Providers." Cryptomator generally supports saving vaults in those spaces, but is dependent on those apps explicitly supporting access by other apps like Cryptomator. For more technical information about this see [here](https://github.com/cryptomator/android/issues/553) for Android and [here](https://github.com/cryptomator/ios/issues/51) for iOS.
+[^file-providers]: Some Android and iOS apps integrate into the operating system's file manager with their own storage spaces to allow seamless access to their files via so-called "File Providers." Cryptomator generally supports saving vaults in those spaces, but is dependent on those apps explicitly supporting access by other apps like Cryptomator. For more technical information about this see [here](https://github.com/cryptomator/android/issues/553) for Android and [here](https://github.com/cryptomator/ios/issues/51) for iOS.📝 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.
Suggested change
| [^file-providers]: Some Android and iOS apps integrate into the operating system's file manager with their own storage spaces to allow seamless access to their files via so called "File Providers." Cryptomator generally supports saving vaults in those spaces, but is dependent on those apps explicitly supporting access by other apps like Cryptomator. For more technical information about this see [here](https://github.com/cryptomator/android/issues/553) for Android and [here](https://github.com/cryptomator/ios/issues/51) for iOS. | |
| [^file-providers]: Some Android and iOS apps integrate into the operating system's file manager with their own storage spaces to allow seamless access to their files via so-called "File Providers." Cryptomator generally supports saving vaults in those spaces, but is dependent on those apps explicitly supporting access by other apps like Cryptomator. For more technical information about this see [here](https://github.com/cryptomator/android/issues/553) for Android and [here](https://github.com/cryptomator/ios/issues/51) for iOS. |
🧰 Tools
🪛 LanguageTool
[grammar] ~52-~52: Use a hyphen to join words.
Context: ...ow seamless access to their files via so called "File Providers." Cryptomator gen...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/misc/supported-cloud-services.mdx` at line 52, Change the user-facing
phrase "so called" to the hyphenated "so-called" in the footnote text identified
by the marker [^file-providers] (the sentence starting "Some Android and iOS
apps integrate into the operating system's file manager... to allow seamless
access to their files via so called "File Providers."). Update that occurrence
to "so-called" so the documentation uses correct hyphenation.
| ### Using Cryptomator Hub {/* #using-cryptomator-hub */} | ||
|
|
||
| When using [Cryptomator Hub](/docs/hub/access-vault.md), the encrypted raw masterkey can be retrieved from a the server component. | ||
| When using [Cryptomator Hub](/docs/hub/access-vault.mdx), the encrypted raw masterkey can be retrieved from a the server component. |
Contributor
There was a problem hiding this comment.
Fix typo in user-facing sentence.
Line 77 has from a the server component → from the server component.
🧰 Tools
🪛 LanguageTool
[grammar] ~77-~77: Ensure spelling is correct
Context: ...ub/access-vault.mdx), the encrypted raw masterkey can be retrieved from a the server comp...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/security/architecture.mdx` at line 77, Fix the typo in the user-facing
sentence that reads "the encrypted raw masterkey can be retrieved from a the
server component" by removing the extraneous "a" so it reads "the encrypted raw
masterkey can be retrieved from the server component"; edit the sentence in
docs/security/architecture.mdx accordingly.
🧩 Analysis chain
🏁 Script executed:
# First, check the file exists and its content
cat -n docs/security/architecture.mdx | sed -n '75,80p'Repository: cryptomator/docs
Length of output: 481
🏁 Script executed:
# Check if the file at /docs/hub/access-vault.mdx exists
fd 'access-vault' docs/Repository: cryptomator/docs
Length of output: 142
🏁 Script executed:
# Check how other links are formatted in the same file
grep -n '\[.*\](/docs' docs/security/architecture.mdx | head -20Repository: cryptomator/docs
Length of output: 195
🏁 Script executed:
# Check Docusaurus config to understand link routing
fd -e 'docusaurus.config' -o -e 'docusaurus.json'Repository: cryptomator/docs
Length of output: 177
🏁 Script executed:
# Check other markdown files in docs/hub to understand naming convention
ls -la docs/hub/Repository: cryptomator/docs
Length of output: 980
🏁 Script executed:
# Check other markdown files to see link formatting patterns
grep -r '\[.*\](/docs.*\.mdx' docs/ | head -10Repository: cryptomator/docs
Length of output: 2227
🏁 Script executed:
# Check Docusaurus config for link/routing settings
find . -name "docusaurus.config.*" -type f | head -5Repository: cryptomator/docs
Length of output: 83
🏁 Script executed:
# Check if there are any markdown/mdx related config files
find . -name "*.config.*" -type f | grep -E "(doc|mdx)" | head -10Repository: cryptomator/docs
Length of output: 83
🏁 Script executed:
# Check the root directory for config files
ls -la | grep -E "(docusaurus|tsconfig|config)"Repository: cryptomator/docs
Length of output: 197
🏁 Script executed:
# Search for any documentation or comments about link formatting
grep -r "\.mdx" docs/ --include="*.md" --include="*.mdx" | grep -i "link\|route\|href" | head -10Repository: cryptomator/docs
Length of output: 42
🏁 Script executed:
# Examine the Docusaurus config for link handling settings
cat -n docusaurus.config.ts | head -100Repository: cryptomator/docs
Length of output: 3381
🏁 Script executed:
# Check for any README or contribution guide that might document link format
find . -name "README*" -o -name "CONTRIBUTING*" | head -5Repository: cryptomator/docs
Length of output: 98
🏁 Script executed:
# Check README for link formatting guidelines
cat README.mdRepository: cryptomator/docs
Length of output: 1155
🏁 Script executed:
# Check CONTRIBUTING guidelines
cat .github/CONTRIBUTING.mdRepository: cryptomator/docs
Length of output: 1407
Fix the typo at line 77.
Change "from a the" to "from the".
Suggested fix
-When using [Cryptomator Hub](/docs/hub/access-vault.mdx), the encrypted raw masterkey can be retrieved from a the server component.
+When using [Cryptomator Hub](/docs/hub/access-vault.mdx), the encrypted raw masterkey can be retrieved from the server component.📝 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.
Suggested change
| When using [Cryptomator Hub](/docs/hub/access-vault.mdx), the encrypted raw masterkey can be retrieved from a the server component. | |
| When using [Cryptomator Hub](/docs/hub/access-vault.mdx), the encrypted raw masterkey can be retrieved from the server component. |
🧰 Tools
🪛 LanguageTool
[grammar] ~77-~77: Ensure spelling is correct
Context: ...ub/access-vault.mdx), the encrypted raw masterkey can be retrieved from a the server comp...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/security/architecture.mdx` at line 77, Fix the typo in
docs/security/architecture.mdx where the sentence "When using [Cryptomator
Hub](/docs/hub/access-vault.mdx), the encrypted raw masterkey can be retrieved
from a the server component." contains "from a the"; change it to "from the" so
the sentence reads "...can be retrieved from the server component." Reference
the sentence containing "encrypted raw masterkey" to locate the change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the project to the recently released docusaurus 3.10.0.
To be prepared for docusaurus 4.0 and following recommended migrations, some additional changes were applied: