From bd64c837b4e284ca9bf133edde8774f4532f2118 Mon Sep 17 00:00:00 2001 From: Zakhar Timoshenko Date: Sat, 14 Oct 2023 20:51:57 +0300 Subject: [PATCH] Docs reorganization --- .vitepress/config/en.ts | 28 +++++++++---------- website/index.md | 2 +- .../{bookmarks.md => bookmarks/index.md} | 0 .../{downloads.md => downloads/index.md} | 0 .../index.md} | 0 .../explore/{random.md => random/index.md} | 0 .../explore/{sources.md => sources/index.md} | 0 .../{suggestions.md => suggestions/index.md} | 0 .../manuals/faq/{feed.md => feed/index.md} | 0 .../faq/{general.md => general/index.md} | 4 +-- .../index.md} | 0 .../faq/{reader.md => reader/index.md} | 0 .../faq/{settings.md => settings/index.md} | 0 .../guides/{backups.md => backups/index.md} | 0 .../{categories.md => categories/index.md} | 0 .../index.md} | 0 .../index.md} | 0 .../guides/{tracking.md => tracking/index.md} | 0 .../index.md} | 6 ++-- .../{diagnosis.md => diagnosis/index.md} | 0 website/sandbox/index.md | 2 +- .../{style-guide.md => style-guide/index.md} | 2 +- website/ua/sandbox/style-guide.md | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) rename website/manuals/faq/explore/{bookmarks.md => bookmarks/index.md} (100%) rename website/manuals/faq/explore/{downloads.md => downloads/index.md} (100%) rename website/manuals/faq/explore/{local-storage.md => local-storage/index.md} (100%) rename website/manuals/faq/explore/{random.md => random/index.md} (100%) rename website/manuals/faq/explore/{sources.md => sources/index.md} (100%) rename website/manuals/faq/explore/{suggestions.md => suggestions/index.md} (100%) rename website/manuals/faq/{feed.md => feed/index.md} (100%) rename website/manuals/faq/{general.md => general/index.md} (98%) rename website/manuals/faq/{miscellaneous.md => miscellaneous/index.md} (100%) rename website/manuals/faq/{reader.md => reader/index.md} (100%) rename website/manuals/faq/{settings.md => settings/index.md} (100%) rename website/manuals/guides/{backups.md => backups/index.md} (100%) rename website/manuals/guides/{categories.md => categories/index.md} (100%) rename website/manuals/guides/{getting-started.md => getting-started/index.md} (100%) rename website/manuals/guides/{synchronization.md => synchronization/index.md} (100%) rename website/manuals/guides/{tracking.md => tracking/index.md} (100%) rename website/manuals/guides/troubleshooting/{common-issues.md => common-issues/index.md} (92%) rename website/manuals/guides/troubleshooting/{diagnosis.md => diagnosis/index.md} (100%) rename website/sandbox/{style-guide.md => style-guide/index.md} (97%) diff --git a/.vitepress/config/en.ts b/.vitepress/config/en.ts index b9614bb..8a726b1 100644 --- a/.vitepress/config/en.ts +++ b/.vitepress/config/en.ts @@ -93,10 +93,10 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] { { text: "Frequently Asked Questions", items: [ - { text: "General", link: "/manuals/faq/general" }, + { text: "General", link: "/manuals/faq/general/" }, { text: "Feed", - link: "/manuals/faq/feed", + link: "/manuals/faq/feed/", }, { text: "Explore", @@ -105,7 +105,7 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] { items: [ { text: "Sources", - link: "/manuals/faq/explore/sources" + link: "/manuals/faq/explore/sources/" }, /* { text: "Local storage", @@ -121,7 +121,7 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] { }, */ { text: "Downloads", - link: "/manuals/faq/explore/downloads", + link: "/manuals/faq/explore/downloads/", }, /* { text: "Suggestions", @@ -131,15 +131,15 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] { }, { text: "Reader", - link: "/manuals/faq/reader", + link: "/manuals/faq/reader/", }, { text: "Settings", - link: "/manuals/faq/settings", + link: "/manuals/faq/settings/", }, { text: "Miscellaneous", - link: "/manuals/faq/miscellaneous" + link: "/manuals/faq/miscellaneous/" } ], }, @@ -148,7 +148,7 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] { items: [ { text: "Getting started", - link: "/manuals/guides/getting-started", + link: "/manuals/guides/getting-started/", }, { text: "Troubleshooting", @@ -157,20 +157,20 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] { items: [ { text: "Common issues", - link: "/manuals/guides/troubleshooting/common-issues", + link: "/manuals/guides/troubleshooting/common-issues/", }, { text: "Diagnosis", - link: "/manuals/guides/troubleshooting/diagnosis", + link: "/manuals/guides/troubleshooting/diagnosis/", }, ], }, - { text: "Backups", link: "/manuals/guides/backups" }, - { text: "Tracking", link: "/manuals/guides/tracking" }, - { text: "Categories", link: "/manuals/guides/categories" }, + { text: "Backups", link: "/manuals/guides/backups/" }, + { text: "Tracking", link: "/manuals/guides/tracking/" }, + { text: "Categories", link: "/manuals/guides/categories/" }, { text: "Synchronization", - link: "/manuals/guides/synchronization" + link: "/manuals/guides/synchronization/" } ], }, diff --git a/website/index.md b/website/index.md index 02d6841..d4d02e6 100644 --- a/website/index.md +++ b/website/index.md @@ -12,7 +12,7 @@ main: link: /download/ - theme: alt text: Manuals - link: /manuals/guides/getting-started + link: /manuals/guides/getting-started/ features: - icon: title: Huge count of sources diff --git a/website/manuals/faq/explore/bookmarks.md b/website/manuals/faq/explore/bookmarks/index.md similarity index 100% rename from website/manuals/faq/explore/bookmarks.md rename to website/manuals/faq/explore/bookmarks/index.md diff --git a/website/manuals/faq/explore/downloads.md b/website/manuals/faq/explore/downloads/index.md similarity index 100% rename from website/manuals/faq/explore/downloads.md rename to website/manuals/faq/explore/downloads/index.md diff --git a/website/manuals/faq/explore/local-storage.md b/website/manuals/faq/explore/local-storage/index.md similarity index 100% rename from website/manuals/faq/explore/local-storage.md rename to website/manuals/faq/explore/local-storage/index.md diff --git a/website/manuals/faq/explore/random.md b/website/manuals/faq/explore/random/index.md similarity index 100% rename from website/manuals/faq/explore/random.md rename to website/manuals/faq/explore/random/index.md diff --git a/website/manuals/faq/explore/sources.md b/website/manuals/faq/explore/sources/index.md similarity index 100% rename from website/manuals/faq/explore/sources.md rename to website/manuals/faq/explore/sources/index.md diff --git a/website/manuals/faq/explore/suggestions.md b/website/manuals/faq/explore/suggestions/index.md similarity index 100% rename from website/manuals/faq/explore/suggestions.md rename to website/manuals/faq/explore/suggestions/index.md diff --git a/website/manuals/faq/feed.md b/website/manuals/faq/feed/index.md similarity index 100% rename from website/manuals/faq/feed.md rename to website/manuals/faq/feed/index.md diff --git a/website/manuals/faq/general.md b/website/manuals/faq/general/index.md similarity index 98% rename from website/manuals/faq/general.md rename to website/manuals/faq/general/index.md index 7f02b49..654cb24 100644 --- a/website/manuals/faq/general.md +++ b/website/manuals/faq/general/index.md @@ -68,7 +68,7 @@ No, you can't. ## Can Kotatsu sync across devices? Yes, the application supports synchronization between devices. -Learn how to create a Kotatsu Sync account [here](/manuals/guides/synchronization) +Learn how to create a Kotatsu Sync account [here](/manuals/guides/synchronization/) ## What do I do if I have to switch to a new phone? @@ -77,5 +77,5 @@ Please follow these steps: 1. Restore the backup. :::tip Note -More information about backup and restore is listed [here](/manuals/guides/backups). +More information about backup and restore is listed [here](/manuals/guides/backups/). ::: \ No newline at end of file diff --git a/website/manuals/faq/miscellaneous.md b/website/manuals/faq/miscellaneous/index.md similarity index 100% rename from website/manuals/faq/miscellaneous.md rename to website/manuals/faq/miscellaneous/index.md diff --git a/website/manuals/faq/reader.md b/website/manuals/faq/reader/index.md similarity index 100% rename from website/manuals/faq/reader.md rename to website/manuals/faq/reader/index.md diff --git a/website/manuals/faq/settings.md b/website/manuals/faq/settings/index.md similarity index 100% rename from website/manuals/faq/settings.md rename to website/manuals/faq/settings/index.md diff --git a/website/manuals/guides/backups.md b/website/manuals/guides/backups/index.md similarity index 100% rename from website/manuals/guides/backups.md rename to website/manuals/guides/backups/index.md diff --git a/website/manuals/guides/categories.md b/website/manuals/guides/categories/index.md similarity index 100% rename from website/manuals/guides/categories.md rename to website/manuals/guides/categories/index.md diff --git a/website/manuals/guides/getting-started.md b/website/manuals/guides/getting-started/index.md similarity index 100% rename from website/manuals/guides/getting-started.md rename to website/manuals/guides/getting-started/index.md diff --git a/website/manuals/guides/synchronization.md b/website/manuals/guides/synchronization/index.md similarity index 100% rename from website/manuals/guides/synchronization.md rename to website/manuals/guides/synchronization/index.md diff --git a/website/manuals/guides/tracking.md b/website/manuals/guides/tracking/index.md similarity index 100% rename from website/manuals/guides/tracking.md rename to website/manuals/guides/tracking/index.md diff --git a/website/manuals/guides/troubleshooting/common-issues.md b/website/manuals/guides/troubleshooting/common-issues/index.md similarity index 92% rename from website/manuals/guides/troubleshooting/common-issues.md rename to website/manuals/guides/troubleshooting/common-issues/index.md index ff4526a..626b599 100644 --- a/website/manuals/guides/troubleshooting/common-issues.md +++ b/website/manuals/guides/troubleshooting/common-issues/index.md @@ -45,7 +45,7 @@ Encountering HTTP errors? Here's what they mean and how to address them. ### `HTTP Error: 403` - Forbidden Possible reasons for this error: -* The selected source has Cloudflare protection. Check the [Cloudflare guide](/manuals/guides/troubleshooting/#cloudflare) for solutions. +* The selected source has Cloudflare protection. Check the [Cloudflare guide](/manuals/guides/troubleshooting/#cloudflare/) for solutions. * The source might be down, removed the series, or banned your IP. > Open WebView to confirm. @@ -60,7 +60,7 @@ This error suggests the source temporarily banned your IP due to fast downloads/ ### `HTTP Error: 5xx` Errors like `500`, `502`, etc., indicate server-side issues on the source's end. -[Check the source in WebView](/manuals/guides/troubleshooting/#accessing-websites-via-webview) to confirm if it's down. +[Check the source in WebView](/manuals/guides/troubleshooting/#accessing-websites-via-webview/) to confirm if it's down. ### `HTTP Error: 1006` This error means a temporary IP ban by the source. @@ -70,5 +70,5 @@ This error points to violating a firewall rule set by the site owner. The owner might raise Cloudflare protection or block IPs from outside their country. ::: warning -For unlisted errors or if instructions don't help, refer to [Diagnosis](/manuals/guides/troubleshooting/diagnosis). +For unlisted errors or if instructions don't help, refer to [Diagnosis](/manuals/guides/troubleshooting/diagnosis/). ::: \ No newline at end of file diff --git a/website/manuals/guides/troubleshooting/diagnosis.md b/website/manuals/guides/troubleshooting/diagnosis/index.md similarity index 100% rename from website/manuals/guides/troubleshooting/diagnosis.md rename to website/manuals/guides/troubleshooting/diagnosis/index.md diff --git a/website/sandbox/index.md b/website/sandbox/index.md index 64d1ad0..fbb2fde 100644 --- a/website/sandbox/index.md +++ b/website/sandbox/index.md @@ -14,7 +14,7 @@ head: # Sandbox Sandbox playground for demonstrating and documenting how different website functions work for easier integration by contributors. -- [Style guide](/sandbox/style-guide) +- [Style guide](/sandbox/style-guide/) ## Shortcodes diff --git a/website/sandbox/style-guide.md b/website/sandbox/style-guide/index.md similarity index 97% rename from website/sandbox/style-guide.md rename to website/sandbox/style-guide/index.md index 371f2b2..dd27709 100644 --- a/website/sandbox/style-guide.md +++ b/website/sandbox/style-guide/index.md @@ -11,7 +11,7 @@ Style guide to aid website content contributors. For the code used for certain s Note that I am not experienced in making these and thus it was created on a whim, if you know any way to improve this page then please submit an edit for it or create an issue. ## FAQ Style -Some **DO**s and **DO NOT**s for [FAQ](/manuals/faq/general). +Some **DO**s and **DO NOT**s for [FAQ](/manuals/faq/general/). - **DO NOT** be afraid to ask for help, this includes clarifying what some parts on this page mean. diff --git a/website/ua/sandbox/style-guide.md b/website/ua/sandbox/style-guide.md index 371f2b2..dd27709 100644 --- a/website/ua/sandbox/style-guide.md +++ b/website/ua/sandbox/style-guide.md @@ -11,7 +11,7 @@ Style guide to aid website content contributors. For the code used for certain s Note that I am not experienced in making these and thus it was created on a whim, if you know any way to improve this page then please submit an edit for it or create an issue. ## FAQ Style -Some **DO**s and **DO NOT**s for [FAQ](/manuals/faq/general). +Some **DO**s and **DO NOT**s for [FAQ](/manuals/faq/general/). - **DO NOT** be afraid to ask for help, this includes clarifying what some parts on this page mean.