From 6e89ce8852a5625214c4339dac991fd781083b9d Mon Sep 17 00:00:00 2001
From: Thanos Apollo <public@thanosapollo.org>
Date: Sun, 18 Feb 2024 18:28:42 +0200
Subject: doc: Add sync devices & fix typos

---
 doc/gnosis.info | 75 +++++++++++++++++++++++++++++++++------------------------
 1 file changed, 44 insertions(+), 31 deletions(-)

(limited to 'doc/gnosis.info')

diff --git a/doc/gnosis.info b/doc/gnosis.info
index 348e70a..c654fcb 100644
--- a/doc/gnosis.info
+++ b/doc/gnosis.info
@@ -29,6 +29,7 @@ This manual is written for Gnosis version 0.1.7, released on 2023-02-18.
 * Note Types::
 * Customization & Extension::
 * Gnosis Algorithm::
+* Sync between devices::
 
 -- The Detailed Node Listing --
 
@@ -55,7 +56,6 @@ Gnosis Algorithm
 * Initial Interval::
 * Easiness Factor::
 * Forgetting Factor::
-* Auto push changes::
 
 
 
@@ -328,7 +328,7 @@ should be done.
      ‘gnosis-display’ functions
 
 
-File: gnosis.info,  Node: Gnosis Algorithm,  Prev: Customization & Extension,  Up: Top
+File: gnosis.info,  Node: Gnosis Algorithm,  Next: Sync between devices,  Prev: Customization & Extension,  Up: Top
 
 6 Gnosis Algorithm
 ******************
@@ -338,7 +338,6 @@ File: gnosis.info,  Node: Gnosis Algorithm,  Prev: Customization & Extension,  U
 * Initial Interval::
 * Easiness Factor::
 * Forgetting Factor::
-* Auto push changes::
 
 
 File: gnosis.info,  Node: Initial Interval,  Next: Easiness Factor,  Up: Gnosis Algorithm
@@ -387,7 +386,7 @@ total easiness factor would be updated by adding the increase factor.
      (setq gnosis-algorithm-ef '(0.30 0.25 1.3))
 
 
-File: gnosis.info,  Node: Forgetting Factor,  Next: Auto push changes,  Prev: Easiness Factor,  Up: Gnosis Algorithm
+File: gnosis.info,  Node: Forgetting Factor,  Prev: Easiness Factor,  Up: Gnosis Algorithm
 
 6.3 Forgetting Factor
 =====================
@@ -405,45 +404,59 @@ interval was 6 days, the next interval will be 6 * 0.5 = 3 days.
      (setq gnosis-algorithm-ff 0.5)
 
 
-File: gnosis.info,  Node: Auto push changes,  Prev: Forgetting Factor,  Up: Gnosis Algorithm
+File: gnosis.info,  Node: Sync between devices,  Prev: Gnosis Algorithm,  Up: Top
 
-6.4 Auto push changes
-=====================
+7 Sync between devices
+**********************
+
+Gnosis uses git to maintain data integrity and facilitate
+synchronization across devices.
+
+   You will need to configure your remote manually.
 
-You can interactively use ‘gnosis-vc-push’ & ‘gnosis-vc-pull’.
+   Example:
 
-   As the name suggests, they rely on ‘vc’ to work properly.
+     cd ~/.emacs.d/gnosis # default location for gnosis
+     git init # After completing your first review session, a git repo should have been initialized automatically.
+     git remote add <remote_name> <remote_url>
+     git push --set-upstream origin master
 
-   Make sure you have setup a git remote for gnosis.
-     cd ~/<your-emacs-directory>/gnosis # default location for gnosis
-     git remote add <remote_name> <remote_url> #
+   You can interactively use ‘gnosis-vc-push’ & ‘gnosis-vc-pull’.  As
+the name suggests, they rely on ‘vc’ to work properly.
 
    Depending on your setup, ‘vc’ might require an external package for
 the ssh passphrase dialog, such as ‘x11-ssh-askpass’.
 
+   To automatically push changes after a review session, add this to
+your configuration:
+     (setf gnosis-vc-auto-push t)
+     (gnosis-vc-pull) ;; Run vc-pull for gnosis on startup
+
+   You might as well add
+
 
 
 Tag Table:
 Node: Top246
-Node: Introduction1277
-Node: Installation1757
-Node: Using straightel2034
-Node: Installing manually from source2546
-Node: Adding notes3235
-Node: Note Types4651
-Node: Cloze4875
-Node: Basic Type5848
-Node: Double6126
-Node: MCQ (Multiple Choice Question)6472
-Node: y-or-n6881
-Node: Customization & Extension7307
-Node: Adjust for typos | String Comparison8020
-Node: Creating Custom Note Types8856
-Node: Gnosis Algorithm9966
-Node: Initial Interval10190
-Node: Easiness Factor10697
-Node: Forgetting Factor11602
-Node: Auto push changes12162
+Node: Introduction1280
+Node: Installation1760
+Node: Using straightel2037
+Node: Installing manually from source2549
+Node: Adding notes3238
+Node: Note Types4654
+Node: Cloze4878
+Node: Basic Type5851
+Node: Double6129
+Node: MCQ (Multiple Choice Question)6475
+Node: y-or-n6884
+Node: Customization & Extension7310
+Node: Adjust for typos | String Comparison8023
+Node: Creating Custom Note Types8859
+Node: Gnosis Algorithm9969
+Node: Initial Interval10200
+Node: Easiness Factor10707
+Node: Forgetting Factor11612
+Node: Sync between devices12146
 
 End Tag Table
 
-- 
cgit v1.2.3