chore: update docs

Author: lincolnthalles

README.md

@@ -1,5 +1,5 @@
 # Memospot documentation
 
-Documentation within "[Writerside](/Writerside/topics)" directory is handled by [JetBrains Writerside](https://www.jetbrains.com/writerside/).
+Documentation within [Writerside](/Writerside/topics) directory is handled by [JetBrains Writerside](https://www.jetbrains.com/writerside/).
 
 A custom Markdown syntax is used. These files are not meant to be read in GitHub.

Writerside/cfg/buildprofiles.xml

@@ -17,4 +17,11 @@
             <noindex-content>false</noindex-content>
         </variables>
     </build-profile>
+    <footer>
+        <link href="https://github.com/memospot/memospot">GitHub</link>
+        <link href="https://github.com/memospot/memospot/releases">Download</link>
+        <link href="https://github.com/memospot/memospot/issues">Issues</link>
+        <link href="https://github.com/memospot/memospot/discussions">Discussions</link>
+        <link href="https://www.usememos.com/docs">Memos Documentation</link>
+    </footer>
 </buildprofiles>

Writerside/images/doclogo.png

@@ -1,5 +1,33 @@
 # Data migration
 
+> The current version of Memos stores assets in a portable format.
+>
+> Data can be seamlessly moved between Memos containers and Memospot instances,
+> regardless of the operating system.
+> {style=note}
+
+> Assets, resources and objects refer to the same thing.
+
+## Data storage location
+
+- Windows: `%LocalAppData%\memospot`
+- POSIX systems: `~/.memospot` (a hidden folder in the user home)
+- Inside Memos container: `/var/opt/memos`
+- Memos' container host:
+    - `~/.memos`
+    - `/root/.memos`
+    - Near your `docker-compose.yml` file if you're using it.
+
+> Relevant files:
+> - `memos_prod.db`
+> - `memos_prod.db-shm` (may not exist)
+> - `memos_prod.db-wal` (may not exist)
+> - `assets` directory
+
+The `.thumbnail_cache` directory and its contents are generated as needed.
+
+## Migrating data from earlier Memos versions
+
 > None of this is needed if you have never stored assets outside the database or
 > if you have used Memospot v0.1.3/v0.1.4 in the past since it contains a
 > built-in database migrator.
@@ -20,7 +48,7 @@
 > If you are coming from an old Memos version or skipped v0.18.2 and v0.19.0,
 > consider installing
 > [Memospot v0.1.4](https://github.com/memospot/memospot/releases/tag/v0.1.4).
-> It will fix the database automatically on the first start. {style=note}
+> It will fix all asset paths in the database automatically on the first start. {style=note}
 
 ## Legacy instructions {collapsible="true" default-state="collapsed"}
 

Writerside/topics/Data-migration.md

@@ -1,24 +1,26 @@
 # Overview
 
-[Memospot](https://github.com/memospot/memospot) is a self-contained
-desktop version of [Memos](https://github.com/usememos/memos), a beautiful,
-privacy-first, lightweight note-taking service.
+[Memospot](https://github.com/memospot/memospot) is a self-contained desktop version of
+[Memos](https://github.com/usememos/memos)—a privacy-first, lightweight note-taking service. Available for Windows, macOS, and Linux.
 
-Available for Windows, macOS, and Linux.
+This project allows you to use Memos locally without the Docker overhead or to easily test Memos before deploying a container. Data can be seamlessly moved between instances.
 
 [![Download](https://img.shields.io/github/downloads/memospot/memospot/total?logo=github)](https://github.com/memospot/memospot/releases)
 [![GitHub Stars](https://img.shields.io/github/stars/memospot/memospot?logo=github)](https://github.com/memospot/memospot)
 
 ## Main screen {collapsible="true" default-state="expanded"}
 
 ![demo](capture.webp){height=1499}
+> Switch the page theme by clicking on the icon in the upper right to
+> see Memospot in a different color scheme.
 
-## Project goals
+## Key features
 
-- Provide an easy-to-use single user Memos instance
+- Easy-to-use
+- Full-featured [Memos experience](https://www.usememos.com/docs)
 - Minimal overhead
 - Data portability
-- Enhanced privacy and data safety
+- Enhanced privacy
 
 ## Requirements
 
@@ -40,16 +42,20 @@ Download the latest release for your platform from the
   [allow the app to run](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac)
   first.
 
-## Data Portability {collapsible="true" default-state="expanded"}
+## Data Portability
 
-The current version of Memos stores assets in a portable format. You can freely
-copy the database and assets folder from one system to another, from a hosted
-Memos instance to a single-user Memospot installation, and the other way around.
+> The current version of Memos stores assets in a portable format.
+>
+> Data can be seamlessly moved between Memos containers and Memospot instances,
+> regardless of the operating system.
+> {style=note}
 
-> If you ever need to do a migration from an older Memos version, check
-> [Data Migration](Data-migration.md).
+> If your data is coming from Memos v0.18.1 or earlier, see
+> [Data migration](Data-migration.md#migrating-data-from-earlier-memos-versions).
 
-## Special Thanks {collapsible="true" default-state="expanded"}
+## Special Thanks
+
+This project is made possible by the following open-source projects:
 
 [![Powered by Memos](powered_by_memos.webp "Memos"){height=128}](https://www.usememos.com/)
 
@@ -68,8 +74,7 @@ Memos instance to a single-user Memospot installation, and the other way around.
 
 ## Supporting
 
-If you like this project, remember to
-[⭐star](https://github.com/memospot/memospot) it.
+If you appreciate this project, be sure to [⭐star](https://github.com/memospot/memospot) it on GitHub.
 
 [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/lincolnthalles)
 [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N5VO0T7)

Writerside/topics/Overview.md

@@ -2,8 +2,8 @@
 
 ## Post-updates
 
-If you see an error while Memos' interface is loading, press F5 or right-click
-the window and click reload.
+If you see an error while Memos' interface is loading, or it stays white/gray,
+press F5 or right-click the window and click reload.
 
 This is caused by a stale WebView cache and also affects Memos' Docker
 instances. It should happen only once right after the update.

Writerside/topics/Troubleshooting.md

@@ -6,12 +6,12 @@ bundled with the latest tested Memos server version.
 
 > An auto-updater is planned, but it's not yet available.
 
-> The semantic version scheme used by Memos is `Major.Minor.Patch`. {style=note}
-
 ## Memos server standalone update
 
-> While a standalone server update works in most cases, manual updates are
-> strongly discouraged for anything other than a **Patch** version release.
+While a standalone server update works in most cases, manual updates are
+strongly discouraged for anything other than a **Patch** version release.
+
+> The semantic version scheme used by Memos is `Major.Minor.Patch`. {style=note}
 
 > Standalone updates can break things due to database and API changes
 > that occur between Major and Minor versions. The current version of Memospot
@@ -38,9 +38,12 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.We
 > [here.](https://raw.githubusercontent.com/memospot/memospot/main/memos-server-updater.ps1)
 > {style=note}
 
-> You must run PowerShell as Admin if you are using Memospot `MSI` installers.
+> You must run PowerShell as Admin if you are using Memospot `MSI` installers,
+> as they do a system-wide installation.
 >
-> This is **not** needed using the `NSIS`/`exe` installer. {style=warning}
+> This is **not** necessary when using the NSIS/exe installer,
+> as it only installs the application for the current user.
+> {style=warning}
 
 ### Manual procedure {collapsible="true" default-state="collapsed"}