branch: elpa/gnosis
commit a38d54d7f99e35509b9d138ef696e8906affe21d
Author: Thanos Apollo <pub...@thanosapollo.org>
Commit: Thanos Apollo <pub...@thanosapollo.org>
doc: Add getting started section.
---
doc/gnosis.info | 115 ++++++++++++++++++++++++++++++++++++++------------------
doc/gnosis.org | 32 +++++++++++-----
doc/gnosis.texi | 55 +++++++++++++++++++++------
3 files changed, 145 insertions(+), 57 deletions(-)
diff --git a/doc/gnosis.info b/doc/gnosis.info
index 0efd83c441..ee605c774d 100644
--- a/doc/gnosis.info
+++ b/doc/gnosis.info
@@ -32,7 +32,7 @@ This manual is written for Gnosis version 0.5.0, released on
2025-06-17.
* Menu:
* Introduction::
-* Adding notes::
+* Getting started::
* Note Types::
* Linking gnosis notes to org-gnosis content::
* Customization::
@@ -44,6 +44,10 @@ This manual is written for Gnosis version 0.5.0, released on
2025-06-17.
-- The Detailed Node Listing --
+Getting started
+
+* Gnosis Dashboard::
+
Note Types
* Cloze::
@@ -61,6 +65,7 @@ Customization
Gnosis Algorithm
* Anagnosis Event::
+* Lethe event::
* Proto::
Interactions with other software
@@ -73,18 +78,14 @@ Contributing
-File: gnosis.info, Node: Introduction, Next: Adding notes, Prev: Top, Up:
Top
+File: gnosis.info, Node: Introduction, Next: Getting started, Prev: Top,
Up: Top
1 Introduction
**************
Gnosis (γνῶσις) is a spaced repetition system that enhances memory
retention through active recall. It employs a Q&A format, where each
-note consists of a question, answer, and explanation. Notes are
-reviewed at optimally spaced intervals based on the user's success or
-failure to recall the answer. Key benefits arise from writing out
-answers when reviewing notes, fostering deeper understanding and
-improved memory retention.
+gnosis consists of a question, answer, and explanation.
Gnosis algorithm is highly adjustable, allowing users to set specific
values not just for note decks but for tags as well. Gnosis'
@@ -94,19 +95,44 @@ personalized learning environment for each topic. Read
more on *note
Gnosis Algorithm::
-File: gnosis.info, Node: Adding notes, Next: Note Types, Prev:
Introduction, Up: Top
+File: gnosis.info, Node: Getting started, Next: Note Types, Prev:
Introduction, Up: Top
-2 Adding notes
-**************
+2 Getting started
+*****************
+
+To follow this tutorial, clone the demo deck available at codeberg
+
+ Demo Deck: <https://codeberg.org/thanosapollo/gnosis-demo>
+
+ Import it to your gnosis collection via ‘M-x gnosis-import-deck’
+
+* Menu:
+
+* Gnosis Dashboard::
+
+
+File: gnosis.info, Node: Gnosis Dashboard, Up: Getting started
+
+2.1 Gnosis Dashboard
+====================
+
+The first thing new users should familiarize themselves with is
+‘gnosis-dashboard’, which you can access via ‘M-x gnosis-dashboard’.
-Creating notes for gnosis can be done interactively with:
+ From there you have access to your review stats & history as well as
+your gnosis contents.
- ‘M-x gnosis-add-note’
+ You can start a review session from the dashboard or with ‘M-x
+gnosis-review’.
- Or from within ‘gnosis-dashboard’
+ NOTE: Gnosis supports reviewing specifics topics for notes of
+‘org-gnosis’ with ‘M-x gnosis-review-topic’
+
+ You can add new gnosis from the dashboard or with ‘M-x
+gnosis-add-note’
-File: gnosis.info, Node: Note Types, Next: Linking gnosis notes to
org-gnosis content, Prev: Adding notes, Up: Top
+File: gnosis.info, Node: Note Types, Next: Linking gnosis notes to
org-gnosis content, Prev: Getting started, Up: Top
3 Note Types
************
@@ -319,10 +345,11 @@ note's answer.
* Menu:
* Anagnosis Event::
+* Lethe event::
* Proto::
-File: gnosis.info, Node: Anagnosis Event, Next: Proto, Up: Gnosis Algorithm
+File: gnosis.info, Node: Anagnosis Event, Next: Lethe event, Up: Gnosis
Algorithm
6.1 Anagnosis Event
===================
@@ -343,9 +370,23 @@ knowledge_
mentioned above by adjusting ‘gnosis-custom-values’.
-File: gnosis.info, Node: Proto, Prev: Anagnosis Event, Up: Gnosis Algorithm
+File: gnosis.info, Node: Lethe event, Next: Proto, Prev: Anagnosis Event,
Up: Gnosis Algorithm
+
+6.2 Lethe event
+===============
+
+The ‘Lethe’ event triggers after a certain number of consecutive
+failures to recall an answer correctly.
+
+ When this threshold is reached, the next interval is reset to 0.
+
+ For example, with lethe value of 2, upon having 2 consecutive failed
+recalls the next review will be set for the current day.
+
+
+File: gnosis.info, Node: Proto, Prev: Lethe event, Up: Gnosis Algorithm
-6.2 Proto
+6.3 Proto
=========
The default initial interval is defined at ‘gnosis-algorithm-proto’, you
@@ -469,25 +510,27 @@ find on the git log.
Tag Table:
Node: Top209
-Node: Introduction1612
-Node: Adding notes2534
-Node: Note Types2788
-Node: Cloze3752
-Node: Default cloze format4141
-Node: Using anki-like syntax4753
-Node: MCQ5845
-Node: Linking gnosis notes to org-gnosis content7050
-Node: Customization7630
-Node: Typos | String Comparison7832
-Node: Gnosis Algorithm8588
-Node: Anagnosis Event9235
-Node: Proto9976
-Node: Editing notes10743
-Node: Sync between devices11135
-Node: Interactions with other software12211
-Node: emacs-no-littering12437
-Node: Contributing12937
-Node: How to create a patch13279
+Node: Introduction1670
+Node: Getting started2357
+Node: Gnosis Dashboard2724
+Node: Note Types3357
+Node: Cloze4324
+Node: Default cloze format4713
+Node: Using anki-like syntax5325
+Node: MCQ6417
+Node: Linking gnosis notes to org-gnosis content7622
+Node: Customization8202
+Node: Typos | String Comparison8404
+Node: Gnosis Algorithm9160
+Node: Anagnosis Event9823
+Node: Lethe event10570
+Node: Proto11014
+Node: Editing notes11777
+Node: Sync between devices12169
+Node: Interactions with other software13245
+Node: emacs-no-littering13471
+Node: Contributing13971
+Node: How to create a patch14313
End Tag Table
diff --git a/doc/gnosis.org b/doc/gnosis.org
index d752df133a..340c20482b 100644
--- a/doc/gnosis.org
+++ b/doc/gnosis.org
@@ -44,11 +44,7 @@ This manual is written for Gnosis version
{{{stable-version}}}, released on {{{r
Gnosis (γνῶσις) is a spaced repetition system that enhances memory
retention through active recall. It employs a Q&A format, where each
-note consists of a question, answer, and explanation. Notes are
-reviewed at optimally spaced intervals based on the user's success or
-failure to recall the answer. Key benefits arise from writing out
-answers when reviewing notes, fostering deeper understanding
-and improved memory retention.
+gnosis consists of a question, answer, and explanation.
Gnosis algorithm is highly adjustable, allowing users to set specific
values not just for note decks but for tags as well. Gnosis'
@@ -57,12 +53,29 @@ note collections but also for specific tagged topics,
thereby creating
a personalized learning environment for each topic. Read more on
[[Gnosis Algorithm]]
-* Adding notes
-Creating notes for gnosis can be done interactively with:
+* Getting started
- =M-x gnosis-add-note=
+To follow this tutorial, clone the demo deck available at codeberg
-Or from within =gnosis-dashboard=
+ Demo Deck: https://codeberg.org/thanosapollo/gnosis-demo
+
+Import it to your gnosis collection via {{{kbd(M-x gnosis-import-deck)}}}
+
+** Gnosis Dashboard
+
+The first thing new users should familiarize themselves with is
+=gnosis-dashboard=, which you can access via {{{kbd(M-x gnosis-dashboard)}}}.
+
+From there you have access to your review stats & history as well as
+your gnosis contents.
+
+You can start a review session from the dashboard or with {{{kbd(M-x
+gnosis-review)}}}.
+
+ NOTE: Gnosis supports reviewing specifics topics for notes of
+ =org-gnosis= with {{{kbd(M-x gnosis-review-topic)}}}
+
+You can add new gnosis from the dashboard or with {{{kbd(M-x
gnosis-add-note)}}}
* Note Types
Each note is a *thema* consisting of the following components:
@@ -314,7 +327,6 @@ To automatically push changes after a review session, add
this to your configura
(gnosis-vc-pull) ;; Run vc-pull for gnosis on startup
#+end_src
-
* Interactions with other software
** emacs-no-littering
diff --git a/doc/gnosis.texi b/doc/gnosis.texi
index 6181900967..845b414a08 100644
--- a/doc/gnosis.texi
+++ b/doc/gnosis.texi
@@ -60,7 +60,7 @@ Git repositories:
@menu
* Introduction::
-* Adding notes::
+* Getting started::
* Note Types::
* Linking gnosis notes to org-gnosis content::
* Customization::
@@ -73,6 +73,10 @@ Git repositories:
@detailmenu
--- The Detailed Node Listing ---
+Getting started
+
+* Gnosis Dashboard::
+
Note Types
* Cloze::
@@ -90,6 +94,7 @@ Customization
Gnosis Algorithm
* Anagnosis Event::
+* Lethe event::
* Proto::
Interactions with other software
@@ -108,11 +113,7 @@ Contributing
Gnosis (γνῶσις) is a spaced repetition system that enhances memory
retention through active recall. It employs a Q&A format, where each
-note consists of a question, answer, and explanation. Notes are
-reviewed at optimally spaced intervals based on the user's success or
-failure to recall the answer. Key benefits arise from writing out
-answers when reviewing notes, fostering deeper understanding
-and improved memory retention.
+gnosis consists of a question, answer, and explanation.
Gnosis algorithm is highly adjustable, allowing users to set specific
values not just for note decks but for tags as well. Gnosis'
@@ -121,14 +122,34 @@ note collections but also for specific tagged topics,
thereby creating
a personalized learning environment for each topic. Read more on
@ref{Gnosis Algorithm}
-@node Adding notes
-@chapter Adding notes
+@node Getting started
+@chapter Getting started
+
+To follow this tutorial, clone the demo deck available at codeberg
+
+Demo Deck: @uref{https://codeberg.org/thanosapollo/gnosis-demo}
+
+Import it to your gnosis collection via @kbd{M-x gnosis-import-deck}
+
+@menu
+* Gnosis Dashboard::
+@end menu
-Creating notes for gnosis can be done interactively with:
+@node Gnosis Dashboard
+@section Gnosis Dashboard
-@samp{M-x gnosis-add-note}
+The first thing new users should familiarize themselves with is
+@samp{gnosis-dashboard}, which you can access via @kbd{M-x gnosis-dashboard}.
-Or from within @samp{gnosis-dashboard}
+From there you have access to your review stats & history as well as
+your gnosis contents.
+
+You can start a review session from the dashboard or with @kbd{M-x
gnosis-review}.
+
+NOTE: Gnosis supports reviewing specifics topics for notes of
+@samp{org-gnosis} with @kbd{M-x gnosis-review-topic}
+
+You can add new gnosis from the dashboard or with @kbd{M-x gnosis-add-note}
@node Note Types
@chapter Note Types
@@ -345,6 +366,7 @@ Gnosis has 2 special events, one is @code{anagnosis}
@emph{ανάγνωση} and
@menu
* Anagnosis Event::
+* Lethe event::
* Proto::
@end menu
@@ -364,6 +386,17 @@ When @code{anagnosis} is triggered by consecutive
@strong{failed} recalls,
You can set specific values for each deck and tag of the variables
mentioned above by adjusting @samp{gnosis-custom-values}.
+@node Lethe event
+@section Lethe event
+
+The @code{Lethe} event triggers after a certain number of consecutive
+failures to recall an answer correctly.
+
+When this threshold is reached, the next interval is reset to 0.
+
+For example, with lethe value of 2, upon having 2 consecutive failed
+recalls the next review will be set for the current day.
+
@node Proto
@section Proto
