docs: improve home page

Signed-off-by: Varun Patil <[email protected]>

.github/workflows/docs.yaml

@@ -19,5 +19,6 @@ jobs:
         with:
           key: ${{ github.ref }}
           path: .cache
+      - run: cp CHANGELOG.md docs/changelog.md
       - run: pip install mkdocs-material
       - run: mkdocs gh-deploy --force

docs/.gitignore

@@ -0,0 +1 @@
+changelog.md

docs/config.md

@@ -1,4 +1,4 @@
-# Overview
+# Configuration
 
 Starting with v5.0.0, you can fully configure memories using the admin panel. With an admin account in Nextcloud, go to `Settings -> Memories`. Memories runs a background indexing job to extract EXIF metadata from photos and videos, as well as immediately on every upload.
 

docs/faq.md

@@ -1,58 +1,78 @@
-# Frequently Asked Questions
+# Support and FAQ
 
-- **How is it different from the default Nextcloud Photos app?**  
-  You can find a full comparison [here](../memories-vs-photos).
+## Getting Help
 
-- **What apps does Memories compete against?**  
-  Commercial cloud photo services. The target is to be better than `X` service provider that you pay $$$ for, and be usable by grandma.
+If you have any questions, feel free to reach out at
 
-- **Is it production ready?**  
-  Yes.
+- [Discord community](https://discord.gg/7Dr9f9vNjJ) (any questions, feedback, suggestions, etc.)
+- [GitHub issues](https://github.com/pulsejet/memories/issues) (bugs and feature requests)
 
-- **Does it support multiple users and external sharing?**  
-  Yes.
+## FAQ
 
-- **Why is it tied to Nextcloud? Isn't this a lot of overhead? Isn't PHP slow?**
+**How is it different from the default Nextcloud Photos app?**
 
-      1.  Reinventing the wheel is pointless. If Memories was a dedicated app, that would mean re-implementing everything from automatic file upload to multi-user support and auth integrations. The maintenance overhead of such a codebase increases exponentially, all while completely unnecessary since someone else is maintaining the exact same things in another piece of software. Integrating with Nextcloud is what makes Memories sustainable.
-      1.  PHP and Nextcloud have become very fast over the last few years, and running both is very minimal overhead. Functions such as upgrading Nextcloud
-      to newer versions is seamless especially when using Docker.
-      1.  The power of Memories is integration: the Nextcloud ecosystem provides tons of other apps for extending functionality.
+You can find a full comparison [here](../memories-vs-photos).
 
-- **Why doesn't it support `<some-feature>` such as XMP tags and advanced metadata editing?**  
-  The target user of Memories is not a tech-savvy self-hoster. Most commonly used / available features will be given priority over advanced features, e.g. most useful for professionals / photographers / data hoarders. That doesn't mean to say these features will necessarily not be implemented.
+**What apps does Memories compete against?**
 
-- **Does Memories support a folder structure for storage?**  
-  Yes. All photos are stored in a folder structure, and only displayed as a flat timeline. This means you can swap out Memories for any other photo app if you want (no lock-in). You can also view the photos in the folder structure if you desire.
+Commercial cloud photo services. The target is to be better than `X` service provider that you pay $$$ for, and be usable by grandma.
 
-- **Does it have a mobile app?**  
-  Not yet. The web app is very responsive on mobile. You can use the official Nextcloud app to auto-upload photos and videos from your device.
+**Is it production ready?**
 
-- **How is it better than the `Y` FOSS photo manager?**  
-  UX and performance. The devil is in the details.
+Yes.
 
-- **It's slow or doesn't work**  
-  Make sure you follow the [configuration steps](../config). Unless you have hundreds of thousands of photos on a Raspberry Pi, Memories should be very fast. File an issue otherwise.
+**Does it support multiple users and external sharing?**
 
-- **Will it run on my system?**  
-  In general, if you can run Nextcloud, you should be able to run Memories. File an issue if you run into problems.
+Yes.
 
-- **How to completely remove Memories? Maybe to reinstall after errors?**
-  Uninstall Memories from the app store, then run the following SQL on your database.
+**Why is it tied to Nextcloud? Isn't this a lot of overhead? Isn't PHP slow?**
 
-      ```sql
-      DROP TABLE IF EXISTS oc_memories;
-      DROP TABLE IF EXISTS oc_memories_livephoto;
-      DROP TABLE IF EXISTS oc_memories_mapclusters;
-      DROP TABLE IF EXISTS oc_memories_places;
-      DROP TABLE IF EXISTS oc_memories_planet;
-      DROP TABLE IF EXISTS memories_planet_geometry;
-      DROP INDEX IF EXISTS memories_parent_mimetype ON oc_filecache;
-      DELETE FROM oc_migrations WHERE app='memories';
-      ```
+1.  Reinventing the wheel is pointless. If Memories was a dedicated app, that would mean re-implementing everything from automatic file upload to multi-user support and auth integrations. The maintenance overhead of such a codebase increases exponentially, all while completely unnecessary since someone else is maintaining the exact same things in another piece of software. Integrating with Nextcloud is what makes Memories sustainable.
+1.  PHP and Nextcloud have become very fast over the last few years, and running both is very minimal overhead. Functions such as upgrading Nextcloud
+    to newer versions is seamless especially when using Docker.
+1.  The power of Memories is integration: the Nextcloud ecosystem provides tons of other apps for extending functionality.
 
-      On Postgres, the syntax for dropping the index is:
+**Why doesn't it support `<some-feature>` such as XMP tags and advanced metadata editing?**
 
-      ```sql
-      DROP INDEX IF EXISTS memories_parent_mimetype;
-      ```
+The target user of Memories is not a tech-savvy self-hoster. Most commonly used / available features will be given priority over advanced features, e.g. most useful for professionals / photographers / data hoarders. That doesn't mean to say these features will necessarily not be implemented.
+
+**Does Memories support a folder structure for storage?**
+
+Yes. All photos are stored in a folder structure, and only displayed as a flat timeline. This means you can swap out Memories for any other photo app if you want (no lock-in). You can also view the photos in the folder structure if you desire.
+
+**Does it have a mobile app?**
+
+Not yet. The web app is very responsive on mobile. You can use the official Nextcloud app to auto-upload photos and videos from your device.
+
+**How is it better than the `Y` FOSS photo manager?**
+
+UX and performance. The devil is in the details.
+
+**It's slow or doesn't work**
+
+Make sure you follow the [configuration steps](../config). Unless you have hundreds of thousands of photos on a Raspberry Pi, Memories should be very fast. File an issue otherwise.
+
+**Will it run on my system?**
+
+In general, if you can run Nextcloud, you should be able to run Memories. File an issue if you run into problems.
+
+**How to completely remove Memories? Maybe to reinstall after errors?**
+
+Uninstall Memories from the app store, then run the following SQL on your database.
+
+```sql
+DROP TABLE IF EXISTS oc_memories;
+DROP TABLE IF EXISTS oc_memories_livephoto;
+DROP TABLE IF EXISTS oc_memories_mapclusters;
+DROP TABLE IF EXISTS oc_memories_places;
+DROP TABLE IF EXISTS oc_memories_planet;
+DROP TABLE IF EXISTS memories_planet_geometry;
+DROP INDEX IF EXISTS memories_parent_mimetype ON oc_filecache;
+DELETE FROM oc_migrations WHERE app='memories';
+```
+
+On Postgres, the syntax for dropping the index is:
+
+```sql
+DROP INDEX IF EXISTS memories_parent_mimetype;
+```

docs/index.md

@@ -1,11 +1,7 @@
 ---
+title: Memories
+template: home.html
 hide:
   - navigation
   - toc
 ---
-
-# Memories Documentation
-
-!!! warning "This page is still under construction."
-
-This is the documentation for the [Memories](https://github.com/pulsejet/memories) app.