Reorganize FAQs (#47)

This commit is contained in:
arkon 2023-09-10 14:36:07 -04:00 committed by GitHub
parent 0af948cd8d
commit dc20ee4420
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 103 additions and 129 deletions

View File

@ -41,48 +41,37 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] {
items: [ items: [
{ text: "General", link: "/docs/faq/general" }, { text: "General", link: "/docs/faq/general" },
{ {
text: "Application", text: "Library",
link: "/docs/faq/application/", link: "/docs/faq/library",
},
{
text: "Browse",
link: "/docs/faq/browse/",
collapsed: true, collapsed: true,
items: [ items: [
{ text: "Extensions", link: "/docs/faq/browse/extensions" },
{ {
text: "Library", text: "Local source",
link: "/docs/faq/application/library", link: "/docs/faq/browse/local-source",
},
{
text: "Browse",
link: "/docs/faq/application/browse/",
collapsed: true,
items: [
{
text: "Local source",
link: "/docs/faq/application/browse/local-source",
},
],
},
{
text: "Downloads",
link: "/docs/faq/application/downloads",
},
{
text: "Reader",
link: "/docs/faq/application/reader",
},
{
text: "Android 11+",
link: "/docs/faq/application/android-11+",
},
{
text: "Shizuku",
link: "/docs/faq/application/shizuku",
},
{
text: "Miscellaneous",
link: "/docs/faq/application/miscellaneous",
}, },
], ],
}, },
{ text: "Extensions", link: "/docs/faq/extensions" }, {
text: "Downloads",
link: "/docs/faq/downloads",
},
{
text: "Reader",
link: "/docs/faq/reader",
},
{
text: "Settings",
link: "/docs/faq/settings",
},
{
text: "Android 11+",
link: "/docs/faq/android-11+",
},
], ],
}, },
{ {
@ -129,6 +118,10 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] {
text: "Reader settings", text: "Reader settings",
link: "/docs/guides/reader-settings", link: "/docs/guides/reader-settings",
}, },
{
text: "Shizuku",
link: "/docs/guides/shizuku",
},
], ],
}, },
] ]

View File

@ -1,25 +0,0 @@
---
title: Application - FAQ
description: Frequently Asked Questions about the Application.
---
# Application
Frequently Asked Questions about the Application.
## What is Tachiyomi Preview?
**Tachiyomi Preview** is a regularly updated beta version of the app.
It showcases potential upcoming features, but it's more prone to bugs and crashes.
Ideal for users seeking the latest **Tachiyomi** experience, it's essential to [enable auto-backup](/docs/guides/backups#enabling-automatic-backups) to prevent library loss due to issues.
## Why aren't library updates working?
Some Android skins (e.g., **MIUI**) aggressively save battery, potentially shutting down apps in the background.
Whitelist **Tachiyomi** from your battery saver by going to <nav to="advanced"> and tapping **Disable battery optimization**.
If unsuccessful, try [DontKillMyApp](https://dontkillmyapp.com/) for battery-saving options on your device and workarounds.
## Why is taking screenshots blocked?
Turn off **Secure Screen** in <nav to="security-and-privacy">.

View File

@ -1,22 +0,0 @@
---
title: Miscellaneous - FAQ
description: Frequently Asked Questions that don't fit other categories.
---
# Miscellaneous
Frequently Asked Questions that don't fit other categories.
## How do I pause reading history?
Activate **Incognito Mode** through <nav to="incognito-mode">.
## Reading downloaded chapters only
Activate **Download only** via <nav to="downloaded-only">.
## Understanding DNS over HTTPS
**DNS over HTTPS (DoH)** offers secure DNS resolution through HTTPS, preventing attacks.
Learn more [here](https://www.cloudflare.com/learning/dns/dns-over-tls/).
Enable in <nav to="advanced">.
## Automatic library backup and data transfer
Learn about automatic backup and restore [here](/docs/guides/backups) and enabling auto backups [here](/docs/guides/backups#enabling-automatic-backups).

View File

@ -1,29 +0,0 @@
---
title: Shizuku
description: Using Shizuku with Tachiyomi.
---
# Shizuku
**Shizuku** is an alternative method for installing and updating extensions in **Tachiyomi**.
It taps into system APIs to directly install packages without requiring user interaction.
To get a detailed understanding of **Shizuku**, its purpose, and how it operates, refer to the information provided [here](https://shizuku.rikka.app/introduction/).
## Is Shizuku necessary?
No. It can be considered if you wish to bypass installation prompts during extension setup.
## Setting up Shizuku
To set up **Shizuku**, follow the instructions [here](https://shizuku.rikka.app/guide/setup/).
After configuring it, activate **Shizuku** within **Tachiyomi** by navigating to <nav to="advanced"> then changing the **Installer** setting.
## Comparing installers
Three installer options are available:
* **Legacy**: A fallback installer if the standard **PackageInstaller** doesn't work.
> This is the default for **MIUI** (i.e. Xiaomi devices).
* **PackageInstaller**: The primary installer option with additional features dependent on the Android version.
> For instance, it can bypass user prompts when updating extensions on **Android 12**.
* **Shizuku**: Refer to the above section for details on **Shizuku**'s functionality.
* **Private**: Installs directly to your device without passing as an application.

View File

@ -6,8 +6,7 @@ description: Frequently Asked Questions about Extensions.
# Extensions # Extensions
Frequently Asked Questions about Extensions. Frequently Asked Questions about Extensions.
## Recommended extensions and sources ## What are some recommended extensions and sources?
**Tachiyomi** does not endorse or recommend any source, and there is no best extension. **Tachiyomi** does not endorse or recommend any source, and there is no best extension.
Instead, we encourage users to spend some time trying out a few sources themselves and discover what sources work best for them. Instead, we encourage users to spend some time trying out a few sources themselves and discover what sources work best for them.
@ -17,12 +16,12 @@ What works well for somebody else might not work well for you.
**Tachiyomi** isn't responsible for slow, down, missing chapters, or subpar image quality of sources as it doesn't host content. **Tachiyomi** isn't responsible for slow, down, missing chapters, or subpar image quality of sources as it doesn't host content.
::: :::
## Scanlator sources ## What is a scanlator source?
Non-officially licensed series are translated by scanlators, often found on their websites or [MangaDex](https://mangadex.org/). Non-officially licensed series are translated by scanlators, often found on their websites or [MangaDex](https://mangadex.org/).
Compare with official sources like [MANGA Plus By SHUEISHA](https://mangaplus.shueisha.co.jp) or [VIZ Shonen Jump](https://www.viz.com/shonenjump). Compare with official sources like [MANGA Plus By SHUEISHA](https://mangaplus.shueisha.co.jp) or [VIZ Shonen Jump](https://www.viz.com/shonenjump).
Learn more in this [Wikipedia article](https://en.wikipedia.org/wiki/Scanlation). Learn more in this [Wikipedia article](https://en.wikipedia.org/wiki/Scanlation).
## Requesting new extensions ## How do I request new extensions?
[Open an issue](https://github.com/tachiyomiorg/tachiyomi-extensions/issues) on **GitHub** if not already there. [Open an issue](https://github.com/tachiyomiorg/tachiyomi-extensions/issues) on **GitHub** if not already there.
Check the removed [extensions list](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475) first. Check the removed [extensions list](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475) first.
@ -35,7 +34,7 @@ When prompted while installing your first extension, allow unknown apps installa
::: details Video guide - Recorded on Android 10 ::: details Video guide - Recorded on Android 10
<video controls muted preload="metadata"> <video controls muted preload="metadata">
<source src="/docs/faq/extensions/unknown-sources-A10.light.webm" type="video/webm"> <source src="/docs/faq/browse/extensions/unknown-sources-A10.light.webm" type="video/webm">
</video> </video>
::: :::
@ -47,20 +46,20 @@ When prompted while installing your first extension, allow unknown apps installa
::: details Video guide - Recorded on Android 7 ::: details Video guide - Recorded on Android 7
<video controls muted preload="metadata"> <video controls muted preload="metadata">
<source src="/docs/faq/extensions/unknown-sources-A7.light.webm"> <source src="/docs/faq/browse/extensions/unknown-sources-A7.light.webm">
</video> </video>
::: :::
:::: ::::
## Uninstalling an extension ## How do I uninstall an extension?
Uninstall extensions like regular apps: through device settings or in **Tachiyomi**. Uninstall extensions like regular apps: through device settings or in **Tachiyomi**.
::: tip Uninstalling an Extension ::: tip Uninstalling an extension
In **Tachiyomi**, uninstall an extension via <nav to="extensions">, then tap **Uninstall** on the chosen extension. In **Tachiyomi**, uninstall an extension via <nav to="extensions">, then tap **Uninstall** on the chosen extension.
::: :::
## Removed extensions ## Why was an extension removed?
Extensions can disappear due to several reasons: Extensions can be removed due to several reasons:
* Frequent website changes. * Frequent website changes.
* Image scrambling. * Image scrambling.
@ -68,4 +67,5 @@ Extensions can disappear due to several reasons:
* Paywall implementation. * Paywall implementation.
* Reverse engineering needs. * Reverse engineering needs.
* Site shutdown. * Site shutdown.
* Find the list of removed extensions [here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475), excluding offline sites.
Find the list of removed extensions [here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475), excluding offline sites.

View File

@ -20,6 +20,12 @@ Porting is difficult due to the separate codebases of iOS and Android apps.
Any app proclaiming to be "**Tachiyomi for iOS**" is not by us and should be treated as a scam. Any app proclaiming to be "**Tachiyomi for iOS**" is not by us and should be treated as a scam.
## What is Tachiyomi Preview?
**Tachiyomi Preview** is a regularly updated beta version of the app.
It showcases potential upcoming features, but it's more prone to bugs and crashes.
Ideal for users seeking the latest **Tachiyomi** experience, it's essential to [enable auto-backup](/docs/guides/backups#enabling-automatic-backups) to prevent library loss due to issues.
## How do I update from the F-Droid builds? ## How do I update from the F-Droid builds?
**Tachiyomi** on **F-Droid** lacks official support, updates aren't guaranteed. **Tachiyomi** on **F-Droid** lacks official support, updates aren't guaranteed.
@ -41,9 +47,5 @@ Refer to [this GitHub comment](https://github.com/tachiyomiorg/tachiyomi/issues/
Projects using the **Tachiyomi** name for anime streaming aren't affiliated with the main project. Projects using the **Tachiyomi** name for anime streaming aren't affiliated with the main project.
## Can I sync between multiple devices?
**Tachiyomi** can't sync between devices.
Use its [backup and restore](/docs/guides/backups) features for series database and content migration to another device.
## What's a fork? ## What's a fork?
Forks are alternate **Tachiyomi** versions with distinct features. Get more details here. Forks are alternate **Tachiyomi** versions with distinct features. Get more details here.

View File

@ -35,6 +35,17 @@ To mitigate these concerns:
* Update only the Reading category by navigating to <nav to="library">, then tap **Categories** under **Global update**. * Update only the Reading category by navigating to <nav to="library">, then tap **Categories** under **Global update**.
* If the warning persists, create a new category for infrequently updated entries (like monthly series or those on hiatus) and set global updates to target the more frequently updated reading category. * If the warning persists, create a new category for infrequently updated entries (like monthly series or those on hiatus) and set global updates to target the more frequently updated reading category.
## Why aren't library updates working?
Some Android skins (e.g., **MIUI**) aggressively save battery, potentially shutting down apps in the background.
Whitelist **Tachiyomi** from your battery saver by going to <nav to="advanced"> and tapping **Disable battery optimization**.
If unsuccessful, refer to [DontKillMyApp](https://dontkillmyapp.com/) for battery-saving options on your device and workarounds.
## Can I sync between multiple devices?
**Tachiyomi** can't sync between devices.
Use its [backup and restore](/docs/guides/backups) features, including [auto backups](/docs/guides/backups#enabling-automatic-backups), for series database and content migration to another device.
## How can I ignore duplicate chapters? ## How can I ignore duplicate chapters?
Dealing with series translated by multiple groups that result in duplicate chapter releases? Dealing with series translated by multiple groups that result in duplicate chapter releases?
@ -55,5 +66,11 @@ Refresh your covers at <nav to="advanced"> then tap **Refresh library covers**.
If certain series chapters are marked as unread without your interaction, it could be due to changed URLs. If certain series chapters are marked as unread without your interaction, it could be due to changed URLs.
**Tachiyomi** detects these changes and interprets the chapters as new. **Tachiyomi** detects these changes and interprets the chapters as new.
## How do I pause reading history?
Activate **Incognito Mode** through <nav to="incognito-mode">.
## How do I only read downloaded chapters?
Activate **Download only** via <nav to="downloaded-only">.
## Why can't I disable the Downloaded filter? ## Why can't I disable the Downloaded filter?
Deactivate **Download only** via <nav to="downloaded-only">. Deactivate **Download only** via <nav to="downloaded-only">.

View File

@ -0,0 +1,22 @@
---
title: Settings
description: Frequently Asked Questions about various settings.
---
# Settings
## Why is taking screenshots blocked?
Turn off **Secure Screen** in <nav to="security-and-privacy">.
## What is DNS over HTTPS?
**DNS over HTTPS (DoH)** (in <nav to="advanced">) offers secure DNS resolution through HTTPS, preventing attacks.
Learn more [here](https://www.cloudflare.com/learning/dns/dns-over-tls/). This may help bypass some basic website blocking.
## What are the different installers?
Three installer options are available (in <nav to="advanced">):
* **Legacy**: A fallback installer if the standard **PackageInstaller** doesn't work.
> This is the default for **MIUI** (i.e. Xiaomi devices).
* **PackageInstaller**: The primary installer option with additional features dependent on the Android version.
> For instance, it can bypass user prompts when updating extensions on **Android 12**.
* **Shizuku**: Refer to the [Shizuku guide](/docs/guides/shizuku) for details on **Shizuku**'s functionality.

View File

@ -34,7 +34,7 @@ Depending on your device settings, you might need to grant **Tachiyomi** permiss
![Security warning](/docs/guides/getting-started/security-warning.webp =546x165) ![Security warning](/docs/guides/getting-started/security-warning.webp =546x165)
> Relevant guide: [Enabling Third-Party Installations](/docs/faq/extensions#enabling-third-party-installations) > Relevant guide: [Enabling Third-Party Installations](/docs/faq/browse/extensions#enabling-third-party-installations)
::: :::
### 3. Adding series to your library ### 3. Adding series to your library

View File

@ -0,0 +1,16 @@
---
title: Shizuku
description: Using Shizuku with Tachiyomi.
---
# Shizuku
**Shizuku** is an alternative method for installing and updating extensions in **Tachiyomi**.
It taps into system APIs to directly install packages without requiring user interaction.
To get a detailed understanding of **Shizuku**, its purpose, and how it operates, refer to the information provided [here](https://shizuku.rikka.app/introduction/).
## Setting up Shizuku
To set up **Shizuku**, follow the instructions [here](https://shizuku.rikka.app/guide/setup/).
After configuring it, activate **Shizuku** within **Tachiyomi** by navigating to <nav to="advanced"> then changing the **Installer** setting.

View File

@ -17,7 +17,7 @@ Here's how to tackle common challenges.
* Else, delete **Tachiyomi** downloads folder on SD card. * Else, delete **Tachiyomi** downloads folder on SD card.
### Storage issues with Android 11+ ### Storage issues with Android 11+
See [this](/docs/faq/application/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/android-11+) section of the FAQ to learn how Scoped Storage affects **Tachiyomi** in **Android 11+** and how to fix it.
### Slow loading ### Slow loading
Sources being slow could stem from site slowness, your internet, or source-imposed rate limits/IP bans. Sources being slow could stem from site slowness, your internet, or source-imposed rate limits/IP bans.