Add documentation for mihonapp/mihon #420 (#47)

* Add FAQ entry for Upcoming Updates * Update upcoming.md Fixed title and description * Fixed spacing for eslint * Added upcoming to sidebar * Apply suggestions from code review Co-authored-by: loocool2 <[email protected]> * Update and rename website/src/docs/faq/upcoming.md to website/src/docs/faq/updates/upcoming.md * Moved navigation entry to Updates category * Fixed indent --------- Co-authored-by: loocool2 <[email protected]>
mihonapp · Mar 28, 2024 · b52c69b · b52c69b
1 parent c6f4e4b
commit b52c69b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/website/src/.vitepress/config/navigation/sidebar.ts b/website/src/.vitepress/config/navigation/sidebar.ts
@@ -45,6 +45,7 @@ function defaultSidebar(): DefaultTheme.SidebarItem[] {
           collapsed: true,
           items: [
             { text: 'Smart updates', link: '/docs/faq/updates/smart' },
+            { text: 'Upcoming', link: '/docs/faq/updates/upcoming' },
           ],
         },
         {

diff --git a/website/src/docs/faq/updates/upcoming.md b/website/src/docs/faq/updates/upcoming.md
@@ -0,0 +1,19 @@
+---
+title: Upcoming
+titleTemplate: Frequently Asked Questions
+description: Frequently Asked Questions about Upcoming Updates
+---
+
+# Upcoming
+Frequently Asked Questions about Upcoming Updates
+
+## What is this Calendar?
+The Upcoming Updates page does *not* consult with external trackers, publishers, or otherwise claim that a chapter update will be released on a particular day.
+
+What it does do is allow users of Mihon to visually plot their upcoming smart updates, as well as get a feel for when new chapters are *expected* to be released.
+
+## What are Smart Updates?
+In order to reduce strain on sources and save user bandwidth, Mihon tries to estimate when chapter updates will be available, and only once that time has passed, include that series in automatic updates.
+
+## Why are my chapter updates on the wrong day?
+Smart updates determine time of chapter updates based on the time between currently released chapters. Sources that provide incorrect update dates, periods of hiatus, or update in batches may result in the estimate seeming off. As more chapters are released, the schedule should become more accurate.