From 9057e4b7d0598dd09320c6eeb355aad5c21ca0ad Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 8 Nov 2022 14:22:42 -0600 Subject: [PATCH] Update documentation --- docs/docs/FAQ.md | 16 +++++++++++++++- docs/static/img/cloud-done.svg | 1 + docs/static/img/cloud-off.svg | 1 + docs/static/img/cloud.svg | 1 + 4 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/static/img/cloud-done.svg create mode 100644 docs/static/img/cloud-off.svg create mode 100644 docs/static/img/cloud.svg diff --git a/docs/docs/FAQ.md b/docs/docs/FAQ.md index 3b96dfa85d..0bf8f77b39 100644 --- a/docs/docs/FAQ.md +++ b/docs/docs/FAQ.md @@ -2,4 +2,18 @@ sidebar_position: 6 --- -# FAQ \ No newline at end of file +# FAQ + +### What is the difference between the cloud icon on the mobile app? + +| Icon | Description | +| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| ![cloud](/img/cloud.svg) | Asset is only available in the cloud and was uploaded from some other device (like the web client) or was deleted from this device after upload | +| ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up | +| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device | + +### How can I sync an existing directory with Immich's server? +Immich doesn't have the mechanism to sync an existing directory with the server. There is however, a helper CLI tool to help you bulk upload the existing photos and videos to the server. You can find the guide to use the CLI tool [here](/docs/usage/bulk-upload.md). + +### Why doesn't Immich watch an existing photo gallery directory? +The initial approach of Immich is to become a backup tool, primarily for mobile device usage. Thus, all the assets must be uploaded from the mobile client. The app was architectured to perform that job well. \ No newline at end of file diff --git a/docs/static/img/cloud-done.svg b/docs/static/img/cloud-done.svg new file mode 100644 index 0000000000..8ab8770a1d --- /dev/null +++ b/docs/static/img/cloud-done.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/cloud-off.svg b/docs/static/img/cloud-off.svg new file mode 100644 index 0000000000..310266ddb2 --- /dev/null +++ b/docs/static/img/cloud-off.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/cloud.svg b/docs/static/img/cloud.svg new file mode 100644 index 0000000000..860fb6a7d8 --- /dev/null +++ b/docs/static/img/cloud.svg @@ -0,0 +1 @@ + \ No newline at end of file