chore: update docs

.github/workflows/writerside.yml

@@ -21,7 +21,7 @@ env:
   # Add the variable below to upload Algolia indexes
   # Replace HI with the ID of the instance in capital letters
   ALGOLIA_ARTIFACT: algolia-indexes-MD.zip
-  ALGOLIA_APP_NAME: GF9WWVY2E3
+  ALGOLIA_APP_ID: GF9WWVY2E3
   ALGOLIA_INDEX_NAME: memospot-docs
   ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }}
   CONFIG_JSON_PRODUCT: md
@@ -116,7 +116,7 @@ jobs:
           unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
           env algolia-key='${{env.ALGOLIA_KEY}}' java -jar /opt/builder/help-publication-agent.jar \
           update-index \
-          --application-name '${{env.ALGOLIA_APP_NAME}}' \
+          --application-name '${{env.ALGOLIA_APP_ID}}' \
           --index-name '${{env.ALGOLIA_INDEX_NAME}}' \
           --product '${{env.CONFIG_JSON_PRODUCT}}' \
           --version '${{env.CONFIG_JSON_VERSION}}' \

Writerside/c.list

@@ -2,5 +2,5 @@
 <!DOCTYPE categories
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
 <categories>
-    <category id="wrs" name="Memospot documentation" order="1"/>
+    <category id="wrs" name="Memospot" order="1"/>
 </categories>

Writerside/cfg/buildprofiles.xml

@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
-                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <variables>
         <noindex-content>true</noindex-content>
-        <color-preset>Vivid</color-preset>
-        <header-logo>doclogo.png</header-logo>
+        <color-preset>contrast</color-preset>
+        <header-logo>logo.png</header-logo>
         <custom-favicons>logo.png</custom-favicons>
         <primary-color>halloween</primary-color>
         <algolia-id>GF9WWVY2E3</algolia-id>
         <algolia-index>memospot-docs</algolia-index>
         <algolia-api-key>b315dd81ad99d5a42d110b2b9252877f</algolia-api-key>
         <web-root>https://memospot.github.io/</web-root>
     </variables>
-    <build-profile instance="md" />
+    <build-profile instance="md"/>
 </buildprofiles>

Writerside/md.tree

@@ -1,9 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE instance-profile
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
-<instance-profile id="md" name="Memospot Documentation" start-page="ABOUT.md">
-    <toc-element topic="ABOUT.md"/>
-    <toc-element topic="DEVELOPMENT.md"/>
-    <toc-element topic="MIGRATION.md"/>
-    <toc-element topic="DEBUGGING.md"/>
+<instance-profile id="md" name="Memospot" start-page="Overview.md">
+    <toc-element topic="Overview.md"/>
+    <toc-element topic="Configuration.md"/>
+    <toc-element topic="Troubleshooting.md"/>
+    <toc-element topic="Updating-Memos.md"/>
+    <toc-element topic="Data-migration.md"/>
+    <toc-element topic="Contributing.md"/>
+    <toc-element topic="Debugging.md"/>
 </instance-profile>

Writerside/redirection-rules.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
+<rules>
+    <!-- format is as follows
+    <rule id="<unique id>">
+        <accepts>page.html</accepts>
+    </rule>
+    -->
+</rules>

Writerside/topics/Configuration.md

@@ -0,0 +1,94 @@
+# Configuration
+
+Though there's no need for a regular user to ever touch this file,
+some of the Memospot behavior can be configured via `memospot.yaml`.
+
+## Configuration location
+
+- Linux/macOS:
+
+```Shell
+~/.memospot/memospot.yaml
+```
+
+- Windows:
+
+    - Explorer:
+
+        ```Shell
+        %LocalAppData%\memospot\memospot.yaml
+        ```
+
+    - Powershell:
+
+      ```Shell
+      $Env:LocalAppData\memospot\memospot.yaml
+      ```
+
+## Sample configuration file
+
+The fields that default to `null` are detected at runtime.
+
+```yaml
+memos:
+  # Memos data storage. Where the database and assets are stored.
+  #
+  # This setting allows you to change the data storage (database,
+  # assets, and thumbnails) to a folder synced by a cloud storage 
+  # provider client, like OneDrive, Dropbox, Google Drive, etc.
+  data: null
+
+  # Use this to spawn a custom Memos binary.
+  binary_path: null
+
+  # Memos working directory. This is where the `dist` folder
+  # must reside (from v0.18.2 to v0.21.0).
+  working_dir: null
+
+  # Mode: [prod] | dev | demo. This changes the database file in use.
+  mode: prod
+
+  # Address where Memos will listen for connections.
+  # Listening to 127.0.0.1 won't trigger Windows Firewall, and the
+  # server instance will only be accessible from the host computer.
+  # This is the default.
+  #
+  # Listening to 0.0.0.0 will make the server available 
+  # at all your computer's network adapters addresses
+  # if it's allowed by the Firewall.
+  addr: 127.0.0.1
+
+  # Memos' port. Managed by Memospot. You can set a custom port,
+  # but it will be automatically changed if the port is in use
+  # during Memospot startup.
+  port: 0
+
+  # Custom environment variables for Memos. 
+  # Custom keys will be automatically uppercased  
+  # and prefixed with "MEMOS_".
+  # Make sure to always quote custom env values, 
+  # so they get parsed as strings.
+  # env:
+  #   NEW_ENV_VAR: "my value"
+  env: null
+memospot:
+  backups:
+    # Enable backups [true]. Currently, backups only run before
+    # database migrations and there's no retention management.
+    enabled: true
+    # Backup directory.
+    path: null
+  migrations:
+    # Enable migrations [true]. Currently, there's one migration 
+    # available that will change local resource paths from absolute 
+    # to relative, making your data fully portable.
+    enabled: true
+  log:
+    # Enable logging [false]. Used for advanced debugging.
+    # A new file called `logging_config.yaml` will be created next 
+    # to this file upon the next Memospot run.
+    # Then, you can edit `logging_config.yaml` changing `root.level`
+    # from `info` to `debug` to increase the logging level.
+    enabled: false
+
+```