Update docs

Closes tachiyomiorg#1090
ayoubfaqraoui · Jan 6, 2024 · 66e017a · 66e017a
1 parent 2d0e505
commit 66e017a
Show file tree

Hide file tree

Showing 11 changed files with 225 additions and 212 deletions.
diff --git a/website/pnpm-lock.yaml b/website/pnpm-lock.yaml
diff --git a/website/src/.vitepress/config/navigation/sidebar.ts b/website/src/.vitepress/config/navigation/sidebar.ts
@@ -69,8 +69,8 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] {
           link: '/docs/faq/settings',
         },
         {
-          text: 'Android 11+',
-          link: '/docs/faq/android-11+',
+          text: 'Storage',
+          link: '/docs/faq/storage',
         },
       ],
     },

diff --git a/website/src/.vitepress/config/shortcodes.ts b/website/src/.vitepress/config/shortcodes.ts
@@ -1,6 +1,5 @@
 const iconMappings = {
   alertDecagramOutline: '<svg originalIcon="alertDecagramOutline" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M23,12L20.56,14.78L20.9,18.46L17.29,19.28L15.4,22.46L12,21L8.6,22.47L6.71,19.29L3.1,18.47L3.44,14.78L1,12L3.44,9.21L3.1,5.53L6.71,4.72L8.6,1.54L12,3L15.4,1.54L17.29,4.72L20.9,5.54L20.56,9.22L23,12M20.33,12L18.5,9.89L18.74,7.1L16,6.5L14.58,4.07L12,5.18L9.42,4.07L8,6.5L5.26,7.09L5.5,9.88L3.67,12L5.5,14.1L5.26,16.9L8,17.5L9.42,19.93L12,18.81L14.58,19.92L16,17.5L18.74,16.89L18.5,14.1L20.33,12M11,15H13V17H11V15M11,7H13V13H11V7" /></svg>',
-  backupRestore: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12,3A9,9 0 0,0 3,12H0L4,16L8,12H5A7,7 0 0,1 12,5A7,7 0 0,1 19,12A7,7 0 0,1 12,19C10.5,19 9.09,18.5 7.94,17.7L6.5,19.14C8.04,20.3 9.94,21 12,21A9,9 0 0,0 21,12A9,9 0 0,0 12,3M14,12A2,2 0 0,0 12,10A2,2 0 0,0 10,12A2,2 0 0,0 12,14A2,2 0 0,0 14,12Z" /></svg>',
   bookmarkBoxOutline: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 20H18V22H4C2.9 22 2 21.1 2 20V6H4V20M22 4V16C22 17.1 21.1 18 20 18H8C6.9 18 6 17.1 6 16V4C6 2.9 6.9 2 8 2H20C21.1 2 22 2.9 22 4M20 4H8V16H20V4M18 6H13V13L15.5 11.5L18 13V6Z" /></svg>',
   bookOpenOutline: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21,4H3A2,2 0 0,0 1,6V19A2,2 0 0,0 3,21H21A2,2 0 0,0 23,19V6A2,2 0 0,0 21,4M3,19V6H11V19H3M21,19H13V6H21V19M14,9.5H20V11H14V9.5M14,12H20V13.5H14V12M14,14.5H20V16H14V14.5Z" /></svg>',
   cloudOffOutline: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19.8 22.6L17.15 20H6.5Q4.2 20 2.6 18.4T1 14.5Q1 12.58 2.19 11.08 3.38 9.57 5.25 9.15 5.33 8.95 5.4 8.76 5.5 8.57 5.55 8.35L1.4 4.2L2.8 2.8L21.2 21.2M6.5 18H15.15L7.1 9.95Q7.05 10.23 7.03 10.5 7 10.73 7 11H6.5Q5.05 11 4.03 12.03 3 13.05 3 14.5 3 15.95 4.03 17 5.05 18 6.5 18M11.13 14M21.6 18.75L20.15 17.35Q20.58 17 20.79 16.54 21 16.08 21 15.5 21 14.45 20.27 13.73 19.55 13 18.5 13H17V11Q17 8.93 15.54 7.46 14.08 6 12 6 11.33 6 10.7 6.16 10.07 6.33 9.5 6.68L8.05 5.23Q8.93 4.63 9.91 4.31 10.9 4 12 4 14.93 4 16.96 6.04 19 8.07 19 11 20.73 11.2 21.86 12.5 23 13.78 23 15.5 23 16.5 22.63 17.31 22.25 18.15 21.6 18.75M14.83 12.03Z" /></svg>',
@@ -17,6 +16,7 @@ const iconMappings = {
   paletteOutline: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12,22A10,10 0 0,1 2,12A10,10 0 0,1 12,2C17.5,2 22,6 22,11A6,6 0 0,1 16,17H14.2C13.9,17 13.7,17.2 13.7,17.5C13.7,17.6 13.8,17.7 13.8,17.8C14.2,18.3 14.4,18.9 14.4,19.5C14.5,20.9 13.4,22 12,22M12,4A8,8 0 0,0 4,12A8,8 0 0,0 12,20C12.3,20 12.5,19.8 12.5,19.5C12.5,19.3 12.4,19.2 12.4,19.1C12,18.6 11.8,18.1 11.8,17.5C11.8,16.1 12.9,15 14.3,15H16A4,4 0 0,0 20,11C20,7.1 16.4,4 12,4M6.5,10C7.3,10 8,10.7 8,11.5C8,12.3 7.3,13 6.5,13C5.7,13 5,12.3 5,11.5C5,10.7 5.7,10 6.5,10M9.5,6C10.3,6 11,6.7 11,7.5C11,8.3 10.3,9 9.5,9C8.7,9 8,8.3 8,7.5C8,6.7 8.7,6 9.5,6M14.5,6C15.3,6 16,6.7 16,7.5C16,8.3 15.3,9 14.5,9C13.7,9 13,8.3 13,7.5C13,6.7 13.7,6 14.5,6M17.5,10C18.3,10 19,10.7 19,11.5C19,12.3 18.3,13 17.5,13C16.7,13 16,12.3 16,11.5C16,10.7 16.7,10 17.5,10Z" /></svg>',
   queryStats: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="m105-233-65-47 200-320 120 140 160-260 109 163q-23 1-43.5 5.5T545-539l-22-33-152 247-121-141-145 233ZM863-40 738-165q-20 14-44.5 21t-50.5 7q-75 0-127.5-52.5T463-317q0-75 52.5-127.5T643-497q75 0 127.5 52.5T823-317q0 26-7 50.5T795-221L920-97l-57 57ZM643-217q42 0 71-29t29-71q0-42-29-71t-71-29q-42 0-71 29t-29 71q0 42 29 71t71 29Zm89-320q-19-8-39.5-13t-42.5-6l205-324 65 47-188 296Z"/></svg>',
   security: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12,12H19C18.47,16.11 15.72,19.78 12,20.92V12H5V6.3L12,3.19M12,1L3,5V11C3,16.55 6.84,21.73 12,23C17.16,21.73 21,16.55 21,11V5L12,1Z" /></svg>',
+  storage: '<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24"><path d="M120-160v-160h720v160H120Zm80-40h80v-80h-80v80Zm-80-440v-160h720v160H120Zm80-40h80v-80h-80v80Zm-80 280v-160h720v160H120Zm80-40h80v-80h-80v80Z"/></svg>',
   sync: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12,18A6,6 0 0,1 6,12C6,11 6.25,10.03 6.7,9.2L5.24,7.74C4.46,8.97 4,10.43 4,12A8,8 0 0,0 12,20V23L16,19L12,15M12,4V1L8,5L12,9V6A6,6 0 0,1 18,12C18,13 17.75,13.97 17.3,14.8L18.76,16.26C19.54,15.03 20,13.57 20,12A8,8 0 0,0 12,4Z" /></svg>',
 }
 
@@ -45,7 +45,7 @@ const navigationMappings: Record<string, Navigation> = {
   'download-queue': { name: 'Download queue', icon: iconMappings.downloadOutline, dependsOn: 'main_more' },
   'categories': { name: 'Categories', icon: iconMappings.labelOutline, dependsOn: 'main_more' },
   'statistics': { name: 'Statistics', icon: iconMappings.queryStats, dependsOn: 'main_more' },
-  'backup-and-restore': { name: 'Backup and restore', icon: iconMappings.backupRestore, dependsOn: 'main_more' },
+  'data-and-storage': { name: 'Data and storage', icon: iconMappings.storage, dependsOn: 'main_more' },
   'settings': { name: 'Settings', icon: iconMappings.cog, dependsOn: 'main_more' },
   'about': { name: 'About', icon: iconMappings.informationOutline, dependsOn: 'main_more' },
   'help': { name: 'Help', icon: iconMappings.helpCircleOutline, dependsOn: 'main_more' },

diff --git a/website/src/docs/faq/android-11+.md b/website/src/docs/faq/android-11+.md
diff --git a/website/src/docs/faq/library.md b/website/src/docs/faq/library.md
@@ -13,6 +13,7 @@ The app's default behavior is to skip updates for entries that meet the followin
 * Have unread chapters
 * Haven't been initiated
 * Carry a "**Completed**" status
+* Isn't expected to have new chapters yet
 
 This strategy prevents unnecessary load which may lead to sources implementing measures against **Tachiyomi**.
 To manage entries with infrequent or no updates, consider using categories and excluding them from updates.

diff --git a/website/src/docs/faq/storage.md b/website/src/docs/faq/storage.md
@@ -0,0 +1,50 @@
+---
+title: Storage
+titleTemplate: Frequently Asked Questions
+description: Understanding Storage Permissions.
+---
+
+# Storage location
+
+Tachiyomi manages several things within a selected storage location, including automatic backups, chapter downloads, and the Local source.
+
+The following illustrates the folder structure:
+
+```txt
+[your selected storage location]/
+    |- autobackup/
+        |- eu.kanade.tachiyomi_yyyy-mm-dd_hh-mm.tachibk
+        |- ...
+    |- downloads/
+        |- Source name (LANG)
+            |- Title
+                |- Chapter01.cbz
+                |- ...
+            |- Other title
+                |- Chapter01.cbz
+                |- ...
+    |- local/
+        |- Title
+            |- Chapter01.cbz
+            |- ...
+        |- Other title
+            |- Chapter01.cbz
+            |- ...
+```
+
+Backup file name prefixes are unique for the app to avoid potential collisions between forks.
+
+## Migrating from v0.14.x or ealier
+
+If you were using the default locations before, then simply select the existing `Tachiyomi` folder.
+
+If were using non-standard downloads folder, you may want to either choose the parent folder (if applicable; avoid choosing the root of your storage) or move your downloads to a new location.
+
+# Scoped Storage
+
+Since Android 11, most apps are enforced to use [Scoped Storage](https://developer.android.com/about/versions/11/privacy/storage) for better security for users so that apps cannot read everything on the device.
+
+**Scoped Storage**'s introduction affects various storage-related functions in **Tachiyomi**.
+These functions may become slower due to **Scoped Storage**'s inherent latency, as discussed in detail [here](https://www.xda-developers.com/android-q-storage-access-framework-scoped-storage/).
+
+This can impact tasks like deleting chapters, library loading times, accessing local files like downloads or the local source, and more.
diff --git a/website/src/docs/guides/backups.md b/website/src/docs/guides/backups.md
@@ -9,7 +9,7 @@ description: Backups helps you prevent losing your library if something happens.
 Backups in **Tachiyomi** are compatible between different versions of the app.
 
 ::: tip How to create a backup
-1. Go to <nav to="backup-and-restore">.
+1. Go to <nav to="data-and-storage">.
 1. Select **Create backup** and choose a location to save it.
 
 ![Backup and Restore](/docs/guides/backups/backup.light.webp#light =414x215)
@@ -28,14 +28,15 @@ Backups in **Tachiyomi** are compatible between different versions of the app.
 - **Series information**
   - Author, Artist, Date Added to Library, Selected Viewer, Read Duration, etc.
 - **Extensions** used
+- **Settings** including app settings and source-specific settings
 
 ### What's NOT included in a backup?
 - **Reading history** of titles NOT in library
-- **Settings** including app settings and extension-specific settings
 - **Downloaded** chapters including [local source](/docs/guides/local-source/) chapters
+- **Custom covers**
 
 ## Restoring a backup
-Restoring a backup can be done through the Backup and Restore settings.
+Restoring a backup can be done through the "Data and storage" settings.
 
 To ensure a smooth restoration process, remember to:
 
@@ -54,7 +55,7 @@ by correctly specifying the Download Location.
 It is highly recommended to enable automatic backups to ensure you can recover in case of any issues.
 
 ::: tip How to enable automatic backups
-1. Go to <nav to="backup-and-restore">.
+1. Go to <nav to="data-and-storage">.
 1. Set a **backup frequency** to schedule automatic backups.
 This way, you can recover from catastrophic failures.
 
@@ -81,7 +82,7 @@ or [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.
 This section explores some extra details regarding [forks](/forks/).
 :::
 
-All [endorsed Tachiyomi forks](/forks/) support the `.proto.gz` format to backup/restore your library.
+All [endorsed Tachiyomi forks](/forks/) support the `.tachibk`/`.proto.gz` format to backup/restore your library.
 
 In addition, some forks have specific limitations regarding backup restoration:
 
@@ -94,7 +95,7 @@ In addition, some forks have specific limitations regarding backup restoration:
   > For Example: [TachiyomiSY](/forks/TachiyomiSY/) has the option to backup/restore saved searches.
 
   These will **NOT** be restored to original Tachiyomi or its forks.
-- Only [TachiyomiAZ](/forks/TachiyomiAZ/) supports creating/restoring both legacy `.json` backups and current `.proto.gz` backups.
-  > Users are recommended to update their `.json` backups to use the improved and efficient `.proto.gz` backups.
+- Only [TachiyomiAZ](/forks/TachiyomiAZ/) supports creating/restoring both legacy `.json` backups and `.proto.gz` backups.
+  > Users are recommended to update their `.json` backups to use the improved and efficient `.tachibk`/`.proto.gz` backups.
 
 Be aware of these limitations when dealing with backups in different **Tachiyomi** forks.
diff --git a/website/src/docs/guides/local-source/index.md b/website/src/docs/guides/local-source/index.md
@@ -14,12 +14,10 @@ This page explores some advanced features.
 
 ## Creating local series
 
-1. Create a folder named `local` in the `/Tachiyomi/` folder.
-
-    > The `/Tachiyomi/` folder is located in the root of phone's **internal storage** or **external SD card** and it's **not related** to the `eu.kanade.tachiyomi/` folder or the download location in the settings.
-1. Place correctly structured series inside `/Tachiyomi/local/`.
+1. In the location you specified as your storage location (e.g., `/Tachiyomi/`), there should be a `local` folder. Place correctly structured series inside that (e.g. `/Tachiyomi/local/`).
 
     > If adding series in folders it is recommended to add a file named `.nomedia` to the local folder so images do not show up in the gallery.
+
 1. You should now be able to access the series in <nav to="sources"> under **Local source**.
 
 If you add more chapters then you'll have to manually refresh the chapter list (by pulling down the list).
@@ -29,66 +27,20 @@ But expect better performance with directories and `ZIP`/`CBZ`.
 
 Note that a single folder or archive file is treated as a single chapter. For example, Tachiyomi will not automatically split an `EPUB` file containing multiple chapters into separate chapters within the app.
 
-Remember to give the app storage permissions on **Android 6** and newer.
-
 ### Folder structure
 
 Tachiyomi requires a specific folder structure for local series to be correctly processed.
-Local series will be read from the `Tachiyomi/local` folder.
+Local series will be read from the `local` folder.
 Each series must have a `Series` folder and a `Chapter` folder.
 Images will then go into the chapter folder.
 See below for more information on archive files.
 You can refer to the following example:
 
-#### Example {#example-storages}
-
-:::tabs
-== Device Storage
-<div class="tree">
-	<ul>
-		<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-		<span class="folder root">/sdcard/Tachiyomi/local</span>
-		<li>
-			<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-			<span class="folder main">[the series title]</span>
-			<ul>
-				<li>
-					<img src="/img/jpeg.svg" alt="File" class="tree-icon icon-jpeg">
-					<span class="file jpg">cover<span class="file-extension">.jpg</span></span>
-				</li>
-				<li>
-					<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-					<span class="folder">chapter_1</span>
-					<ul>
-						<li><span class="file">image_1<span class="file-extension">.ext</span></span></li>
-						<li><span class="file">image_n<span class="file-extension">.ext</span></span></li>
-					</ul>
-				</li>
-				<li>
-					<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-					<span class="folder">chapter_2</span>
-					<ul>
-						<li><span class="file">image_1<span class="file-extension">.ext</span></span></li>
-						<li><span class="file">image_n<span class="file-extension">.ext</span></span></li>
-					</ul>
-				</li>
-				<li>
-					<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-					<span class="folder">chapter_n</span>
-					<ul>
-						<li><span class="file">image_1<span class="file-extension">.ext</span></span></li>
-						<li><span class="file">image_n<span class="file-extension">.ext</span></span></li>
-					</ul>
-				</li>
-			</ul>
-		</li>
-	</ul>
-</div>
-== SD Card
+:::info Example
 <div class="tree">
 	<ul>
 		<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-		<span class="folder root">/storage/18F5-2C11/Tachiyomi/local</span>
+		<span class="folder root">[your storage location]/local</span>
 		<li>
 			<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
 			<span class="folder main">[the series title]</span>
@@ -127,7 +79,7 @@ You can refer to the following example:
 </div>
 :::
 
-Tachiyomi will see four chapters in a single series.
+Tachiyomi will see three chapters in a single series.
 The path to the folder with images must contain both the series title and the chapter name (as seen above).
 
 ### Archive files
@@ -144,7 +96,7 @@ All images inside the archive regardless of folder structure will become pages f
 <div class="tree">
 	<ul>
 		<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
-		<span class="folder root">/sdcard/Tachiyomi/local</span>
+		<span class="folder root">[your storage location]]/local</span>
 		<li>
 			<img src="/img/folder.svg" alt="Folder" class="tree-icon icon-folder">
 			<span class="folder main">[the series title]</span>

diff --git a/website/src/docs/guides/reader-settings.md b/website/src/docs/guides/reader-settings.md
@@ -15,17 +15,17 @@ This section relates to the reading experience in the app and navigating the rea
 This setting sets the reader's default direction when you open a series.
 
 ::: tabs
-== Paged (RTL)
+== Paged (right to left)
 Right-to-left, the default way of reading manga.
 
 - Swipe right for next page.
 - Swipe left for previous page.
-== Paged (LTR)
+== Paged (left to right)
 Left-to-right, the default way of reading comics.
 
 - Swipe left for next page.
 - Swipe right for previous page.
-== Paged (Vertical)
+== Paged (vertical)
 - Swipe up for next page.
 - Swipe down for previous.
 
@@ -243,21 +243,7 @@ TBA
 :::
 
 ### Side padding <Badge type="info" text="None" />
-
-::: tabs
-== None
-TBA
-== 5%
-TBA
-== 10%
 TBA
-== 15%
-TBA
-== 20%
-TBA
-== 25%
-TBA
-:::
 
 ### Sensitivity for hiding menu on scroll <Badge type="info" text="Low" />
 

diff --git a/website/src/docs/guides/troubleshooting/common-issues.md b/website/src/docs/guides/troubleshooting/common-issues.md
@@ -18,7 +18,7 @@ Here's how to tackle common challenges.
 * Else, delete **Tachiyomi** downloads folder on SD card.
 
 ### Storage issues with Android 11+
-See [this](/docs/faq/android-11+) section of the FAQ to learn how Scoped Storage affects **Tachiyomi** in **Android 11+** and how to fix it.
+See [this](/docs/faq/storage) section of the FAQ to learn how Scoped Storage affects **Tachiyomi** in **Android 11+** and how to fix it.
 
 ### Slow loading
 Sources being slow could stem from site slowness, your internet, or source-imposed rate limits/IP bans.

diff --git a/website/src/sandbox/index.md b/website/src/sandbox/index.md
@@ -39,7 +39,7 @@ In <nav to="advanced">, try **Clear cache** and **Clear cookies**.
 <nav to="download-queue">
 <nav to="categories">
 <nav to="statistics">
-<nav to="backup-and-restore">
+<nav to="data-and-storage">
 <nav to="settings">
 <nav to="about">
 <nav to="help">
@@ -62,7 +62,7 @@ In <nav to="advanced">, try **Clear cache** and **Clear cookies**.
 - <nav to="download-queue">
 - <nav to="categories">
 - <nav to="statistics">
-- <nav to="backup-and-restore">
+- <nav to="data-and-storage">
 - <nav to="settings">
 - <nav to="about">
 - <nav to="help">