Merge pull request #395 from Scriptbash/docs-update

Update docs

Author: Scriptbash

package.json

@@ -0,0 +1,53 @@
+---
+sidebar_position: 6
+---
+
+# Custom Feeds
+
+By default, the main feed displays all articles from followed journals. Wispar provides advanced filtering capabilities to create custom views based on specific criteria. These filters operate directly on the local database to surface the most relevant content.
+
+## Creating a Custom Feed
+To create a new custom feed:
+1. Tap the **Wispar icon** at the top right of the main screen.
+2. Select **Create a custom feed**.
+3. Define the desired criteria in the configuration panel and tap **Save**.
+
+## Switching Between Feeds
+Once custom feeds are created, switching between them is handled through the App Bar:
+- Tap the **Feed Name** on the left of the App Bar (by default, this displays "Home").
+- A small down arrow indicates that this title is a menu. 
+- Tapping it opens a dialog window containing the list of all available feeds.
+- Selecting a name from the list will immediately update the feed to match those criteria.
+
+## Managing Existing Feeds
+To modify or remove feeds, open the feed selection dialog as described above and tap the **Edit** button:
+- **Edit:** Tap the **pencil icon** next to a feed name to reopen the configuration panel.
+- **Delete:** Tap the **trash can icon** to permanently remove a custom feed.
+- *Note: The default "Home" feed cannot be edited or deleted.*
+
+## Filter Criteria
+
+### 1. Feed Name
+Each configuration requires a unique name, which is used for identification in the App Bar menu.
+
+### 2. Journal Selection
+Filters can be restricted to specific journals:
+- **Followed Journals:** Selection from the list of journals currently being followed.
+- **More Journals:** Selection from journals cached in the local database that are not actively followed.
+- **Select All/Clear All:** Shortcuts to manage large lists of journals quickly.
+
+### 3. Keyword Filtering
+- **Include Keywords:** Only articles containing at least one of these terms in the title or abstract will be displayed. Enter a word and press **Space** to create a tag.
+- **Exclude Keywords:** Any article containing these terms will be hidden. This is useful for removing recurring unrelated topics.
+
+### 4. Publication Date
+- **None:** No date filtering is applied.
+- **Published After/Before/Between:** Restricts the feed to articles within specific timeframes.
+
+## Saving and Synchronization
+- Saved filters are applied immediately.
+- If **Cloud Sync** is enabled, feed configurations are automatically synchronized across all connected devices.
+
+:::tip
+Custom feeds are non-destructive. Creating or deleting a filter does not affect the stored articles; it only changes which articles are currently visible.
+:::

website/docs/custom-feeds.mdx

@@ -1,15 +1,19 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # FAQ
 
 ## Do I need an account to use Wispar?
 
-No. Wispar does not require any kind of account. In fact, there is no account creation at all. Your data stays entirely in a local database on your device. An institutional account is only needed if you configure an institution in the EZproxy settings.
+No. Wispar is designed to be fully functional without an account. By default, all data (followed journals, favorites, settings, etc.) is stored locally on the device.
+
+Account creation is only required if the optional **Device Synchronization** feature is used. Users can choose between a hosted service (**Wispar Sync**) or a **Self-hosted** backend. In both cases, the account is only used to facilitate data mirroring across multiple devices.
+
+An institutional account is separate and only needed if an institution is configured in the EZproxy settings to access paywalled content.
 
 ## My institution is not available in the list of proxies. How can it be added?
 
-If your institution uses EZproxy, OpenAthens, or a similar proxy, it can be included by either submitting a pull request or opening an issue in the following GitHub repository: [ezproxy-db](https://github.com/tom5760/ezproxy-db)
+If an institution uses EZproxy, OpenAthens, or a similar proxy service and is missing from the list, it can be added by submitting a pull request or opening an issue in the following repository: [ezproxy-db](https://github.com/tom5760/ezproxy-db)
 
-Once the proxy is added to the repository, it will automatically become available in Wispar, since the proxy list is not cached.
+Once the proxy is added to that database, it becomes available in Wispar immediately, as the proxy list is fetched dynamically and not cached.

website/docs/faq.mdx

@@ -6,6 +6,19 @@ sidebar_position: 1
 
 Wispar has an optional cloud syncing feature to synchronize your database on multiple devices. It uses [PocketBase](https://pocketbase.io) to mirror the app's database.
 
+### What is synced?
+| Feature | Status |
+| :--- | :--- |
+| **Articles** (Favorites & Hidden) | ✅ Synced |
+| **Journals** | ✅ Synced |
+| **Saved Queries** | ✅ Synced |
+| **Custom Feeds** | ✅ Synced |
+| **EZproxy URLs** | ✅ Synced |
+| **Downloads (PDFs)** | ❌ Local Only |
+| **Translations & Graphical Abstracts** | ❌ Local Only |
+| **App Settings** | ❌ Local Only |
+
+
 You can either use Wispar Sync, a hosted sync service, or self-host the sync backend to stay in control of your data.
 
 ## Wispar Sync (hosted)

website/docs/initial-setup/cloud-sync.mdx

@@ -3,6 +3,6 @@
   "position": 2,
   "link": {
     "type": "generated-index",
-    "description": "Wispar can currently be installed on both Android and iOS devices."
+    "description": "Wispar can currently be installed on Android, iOS, Windows and MacOS devices. A Linux build is also available in the GitHub releases, but isn't packaged yet."
   }
 }

website/docs/installation/_category_.json

@@ -2,19 +2,26 @@
 sidebar_position: 1
 ---
 
-# Android devices
+# Android Installation
 
-Wispar can be installed on Android devices in three different ways:
+Wispar is available for Android through several different distribution channels to suit your preference.
 
-## Using Google Play
-   https://play.google.com/store/apps/details?id=app.wispar.wispar
+## Google Play Store
+The easiest way for most users to stay up to date:  
+[**Get it on Google Play**](https://play.google.com/store/apps/details?id=app.wispar.wispar)
 
-## Using F-Droid
-   https://f-droid.org/packages/app.wispar.wispar
+## F-Droid
+For users who prefer the open-source community repository and better privacy:  
+[**Download on F-Droid**](https://f-droid.org/packages/app.wispar.wispar)
 
-## Sideloading the APK
-   https://github.com/Scriptbash/Wispar/releases/latest
+## Direct APK (GitHub)
+You can download the latest `.apk` file directly from the releases page:  
+[**Latest GitHub Releases**](https://github.com/Scriptbash/Wispar/releases/latest)
 
-   :::tip[Tip] 
-   You can use an app like [Obtainium](https://github.com/ImranR98/Obtainium) to automatically update the app using the Github releases
-   :::
+:::warning[Third party APK websites]
+Please prioritise downloading Wispar from the links listed above. Unofficial distribution sites may host modified or outdated versions of the app, which could affect performance or security.
+:::
+
+:::tip 
+If you prefer sideloading but want automatic updates, you can use [Obtainium](https://github.com/ImranR98/Obtainium) to track the GitHub repository and install updates as soon as they are released.
+:::

website/docs/installation/android.mdx

@@ -0,0 +1,16 @@
+---
+sidebar_position: 2
+---
+
+# iOS Installation
+
+For iOS devices, Wispar is available exclusively through the official Apple App Store.
+
+## Install via App Store
+You can download Wispar directly to your iPhone or iPad using the link below:
+
+[**Download on the App Store**](https://apps.apple.com/us/app/wispar/id6741366984)
+
+:::tip
+If you are using a Mac with Apple Silicon (M1, M2, M3, etc.), you can also install the iOS version of Wispar directly through the **Mac App Store**. This version will automatically receive updates along with the mobile app.
+:::

website/docs/installation/ios.md

@@ -0,0 +1,21 @@
+---
+sidebar_position: 4
+---
+
+# macOS Installation
+
+To install Wispar on macOS, download the latest installer from the GitHub releases:  
+[**Download Wispar-macos.dmg**](https://github.com/Scriptbash/Wispar/releases/latest)
+
+## Installation Steps
+1. Open the `.dmg` file.
+2. Drag **Wispar** into your **Applications** folder.
+3. Launch Wispar from your Applications or via Spotlight.
+
+:::tip
+If you are using a Mac with Apple Silicon (M1, M2, M3, etc.), you can also install the iOS version of Wispar directly through the **Mac App Store**. This version will automatically receive updates along with the mobile app.
+:::
+
+:::info
+Wispar currently doesn't have a self-updating mechanism for the `.dmg` version. Please check the [project repository](https://github.com/Scriptbash/Wispar) from time to time to ensure you are running the latest version!
+:::

website/docs/installation/ios.mdx

@@ -0,0 +1,25 @@
+---
+sidebar_position: 3
+---
+
+# Windows Installation
+
+To install Wispar on Windows, download the installer from the GitHub releases:  
+[**Download wispar_setup.exe**](https://github.com/Scriptbash/Wispar/releases/latest)
+
+## Installation Steps
+1. Run the `wispar_setup.exe` file.
+2. Follow the setup wizard instructions to choose your installation directory.
+3. Once finished, you can launch Wispar from your Start Menu or Desktop.
+
+:::tip[Windows smartscreen]
+Because Wispar is an independent open-source project, you may see a "Windows protected your PC" message. 
+
+**To continue:**
+1. Click **More info**.
+2. Click **Run anyway**.
+:::
+
+:::info
+Wispar currently doesn't have a self-updating mechanism. Please check the [project repository](https://github.com/Scriptbash/Wispar) from time to time to ensure you are running the latest version!
+:::