Progress

ronzulu · Jul 30, 2024 · 3a7457b · 3a7457b
1 parent 274a970
commit 3a7457b
Show file tree

Hide file tree

Showing 13 changed files with 78 additions and 59 deletions.
diff --git a/...ashcards/cloze-cards/basic-cloze-cards.md → docs/en/flashcards/basic-cloze-cards.md b/...ashcards/cloze-cards/basic-cloze-cards.md → docs/en/flashcards/basic-cloze-cards.md
@@ -1,6 +1,6 @@
 # Basic Cloze Cards
 
-With [Single & Multiline Cards](../flashcard-syntax.md) the text of both the front and back of each card is specified.
+With [Single & Multiline Cards](../flashcards/qanda-cards.md) the text of both the front and back of each card is specified.
 
 With `cloze` cards a single text is specified, together with an identification of which parts of the text should be obscured.
 

diff --git a/docs/en/flashcards/flashcard-settings.md b/docs/en/flashcards/flashcard-settings.md
diff --git a/docs/en/flashcards/flashcards.md b/docs/en/flashcards/flashcards.md
@@ -3,7 +3,7 @@
 Flashcards are defined within standard Obsidian markdown files.
 
 A markdown file containing flashcards must identify the [deck](decks.md) (or decks) into which the flashcards are placed. 
-However, the file does not need to be tagged as a [note](notes.md) for it to have flashcards defined.
+However, the file does not need to be tagged as a [note](../notes.md) for it to have flashcards defined.
 
 Two types of flashcards are supported:
 

diff --git a/docs/en/index.md b/docs/en/index.md
@@ -15,8 +15,10 @@ Fight the forgetting curve by reviewing flashcards & notes using spaced repetiti
 
 !!! tip "Features"
 
-    :material-circle-medium: [Flashcards](flashcards.md)<br/>
-    :material-circle-medium: [Notes](notes.md)
+    :material-circle-medium: [Flashcards](flashcards/flashcards.md) &nbsp; &nbsp; :material-circle-medium: [Notes](notes.md)
+    <hr class="thin">
+    :material-circle-medium: [Repetition Algorithms](algorithms.md) &nbsp; &nbsp; :material-circle-medium: [Data Storage](data-storage.md)
+
 
 !!! tip "Help & Support"
 
@@ -29,23 +31,44 @@ Fight the forgetting curve by reviewing flashcards & notes using spaced repetiti
 </div>
 
 
+---
 
 
 ## Quick Demo
 
+
+![user-interface-overview](https://github.com/user-attachments/assets/977bab30-cc5e-4b5c-849e-3881d82b3f8e)
+
+
+!!! note ""
+
+    1. Display the [Note Review Queue](notes.md#note-review-queue) <br/>
+    2. Note review queue<br/>
+    3. Display the Obsidian command dialog to access the plugin [commands](plugin-commands.md)<br/>
+    4. Select a flashcard [deck](flashcards/reviewing.md#deck-selection) to [review](flashcards/reviewing.md#reviewing) <br/>
+    5. Identify that flashcards within this note are in the `#flashcards/science/physics` [deck](flashcards/decks.md#using-obsidian-tags)<br/>
+    6. A [single line question](flashcards/qanda-cards.md#single-line-basic) (identified by the `::` separating the question and answer)<br/>
+    7. The plugin stores scheduling info within this [HTML comment](data-storage.md#individual-markdown-files) <br/>
+    8. The number of notes and flashcards currently due for review. Click to SOMETHING.
+
+
 <video controls>
   <source src="https://user-images.githubusercontent.com/43380836/115256965-5d455f00-a138-11eb-988f-27ba29f328a0.mp4" type="video/mp4">
 </video>
 
+---
+
+
 ## Installation
 
 You can easily install the plugin from Obsidian's community plugin section in the Obsidian app (Search for `Spaced Repetition`).
 
 ### Manual Installation
 
 !!! note "Advanced"
-  Create an `obsidian-spaced-repetition` folder under `.obsidian/plugins` in your vault. Add the `main.js`, `manifest.json`, and the `styles.css` files from the [latest release](https://github.com/st3v3nmw/obsidian-spaced-repetition/releases) to the folder.
+    Create an `obsidian-spaced-repetition` folder under `.obsidian/plugins` in your vault. Add the `main.js`, `manifest.json`, and the `styles.css` files from the [latest release](https://github.com/st3v3nmw/obsidian-spaced-repetition/releases) to the folder.
 
+---
 
 ## Support
 

diff --git a/docs/en/media/image-annotation.docx b/docs/en/media/image-annotation.docx
diff --git a/docs/en/media/settings-notes.jpg b/docs/en/media/settings-notes.jpg
diff --git a/docs/en/notes.md b/docs/en/notes.md
@@ -5,7 +5,11 @@
 
 ## Getting started
 
-Tag any notes that you'd like to review as `#review`. This default tag can be changed in the settings. (You can also use multiple tags)
+Tag any notes that you'd like to review as `#review`. This default tag can be changed in the [settings](plugin-settings.md#note-settings). (You can also use multiple tags)
+
+## Note Review Queue
+
+
 
 ## New Notes
 
@@ -47,23 +51,3 @@ Alternatively, one can use the `Open a note for review` command.
 ## Review Queue
 
 -   Daily review entries are sorted by importance (PageRank)
-
-## Incremental Writing
-
-This was introduced [here](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/15) by `@aviskase`.
-
-Here are the YouTube videos:
-
--   English: [Obsidian: inbox review with spaced repetition](https://youtu.be/zG5r7QIY_TM)
--   Russian / русский: [Yuliya Bagriy - Разгребатель инбокса заметок как у Andy Matuschak в Obsidian](https://www.youtube.com/watch?v=CF6SSHB74cs)
-
-### Brief summary
-
-Andy Matuschak uses [spaced repetition system for working on writing inbox](https://notes.andymatuschak.org/z7iCjRziX6V6unNWL81yc2dJicpRw2Cpp9MfQ).
-
-In short, there are four possible actions (where `x < y`):
-
--   skip note (increase interval for `x`) == mark as `good`
--   work on it, mark as fruitful work (decrease interval) == mark as `hard`
--   work on it, mark as unfruitful work (increase interval for `y`) == mark as `easy`
--   convert to evergreen note (stop using the space-repetition prompts)
diff --git a/docs/en/plugin-settings.md b/docs/en/plugin-settings.md
@@ -18,6 +18,14 @@
 
 ![flashcard-settings-scheduling-data](https://github.com/user-attachments/assets/200bb976-c631-4d73-82a5-12ba7e140339)
 
+---
+
+## Note Settings
+
+![settings-notes](https://github.com/user-attachments/assets/75f7a55a-933f-436f-868a-efb622cc0f9c)
+
+---
+
 ## UI Preferences
 
 ![settings-ui-preferences](https://github.com/user-attachments/assets/c0740fa0-02b5-4db9-9d81-94f0ae29ab6c)

diff --git a/docs/en/resources.md b/docs/en/resources.md
@@ -22,7 +22,25 @@
 
 ### Incremental Writing
 
--   [Obsidian: inbox review with spaced repetition by @aviskase :fontawesome-brands-youtube:{ .youtube } ](https://youtu.be/zG5r7QIY_TM)
--   [Разгребатель инбокса заметок как у Andy Matuschak в Obsidian by @YuliyaBagriy_ru :fontawesome-brands-youtube:{ .youtube } ](https://youtu.be/CF6SSHB74cs)
 
+-   English: [Obsidian: inbox review with spaced repetition by @aviskase :fontawesome-brands-youtube:{ .youtube } ](https://youtu.be/zG5r7QIY_TM)
+-   Russian / русский: [Разгребатель инбокса заметок как у Andy Matuschak в Obsidian by @YuliyaBagriy_ru :fontawesome-brands-youtube:{ .youtube } ](https://youtu.be/CF6SSHB74cs)
 
+!!! bug "Improvement Needed"
+    Extract anything important from the reference and include here instead
+
+This was introduced [here](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/15) by `@aviskase`.
+
+### Brief summary
+
+Andy Matuschak uses [spaced repetition system for working on writing inbox](https://notes.andymatuschak.org/z7iCjRziX6V6unNWL81yc2dJicpRw2Cpp9MfQ).
+
+!!! bug "Improvement Needed"
+    What does this mean?
+
+In short, there are four possible actions (where `x < y`):
+
+-   skip note (increase interval for `x`) == mark as `good`
+-   work on it, mark as fruitful work (decrease interval) == mark as `hard`
+-   work on it, mark as unfruitful work (increase interval for `y`) == mark as `easy`
+-   convert to evergreen note (stop using the space-repetition prompts)
diff --git a/docs/en/user-doco-vault/.obsidian/workspace.json b/docs/en/user-doco-vault/.obsidian/workspace.json
@@ -13,7 +13,7 @@
             "state": {
               "type": "markdown",
               "state": {
-                "file": "Computing/AWS/DynamoDB/94. DynamoDB Partitions and Primary Keys.md",
+                "file": "User Guide/Context.md",
                 "mode": "source",
                 "source": false
               }
@@ -85,7 +85,7 @@
             "state": {
               "type": "backlink",
               "state": {
-                "file": "Computing/AWS/DynamoDB/94. DynamoDB Partitions and Primary Keys.md",
+                "file": "User Guide/Context.md",
                 "collapseAll": false,
                 "extraContext": false,
                 "sortOrder": "alphabetical",
@@ -102,7 +102,7 @@
             "state": {
               "type": "outgoing-link",
               "state": {
-                "file": "Computing/AWS/DynamoDB/94. DynamoDB Partitions and Primary Keys.md",
+                "file": "User Guide/Context.md",
                 "linksCollapsed": false,
                 "unlinkedCollapsed": true
               }
@@ -125,7 +125,7 @@
             "state": {
               "type": "outline",
               "state": {
-                "file": "Computing/AWS/DynamoDB/94. DynamoDB Partitions and Primary Keys.md"
+                "file": "User Guide/Context.md"
               }
             }
           },
@@ -152,22 +152,22 @@
       "daily-notes:Open today's daily note": false,
       "templates:Insert template": false,
       "command-palette:Open command palette": false,
-      "obsidian-spaced-repetition:Review flashcards": false,
       "obsidian-spaced-repetition-rz:Review flashcards": false
     }
   },
   "active": "2cb81aad0c9cc3a2",
   "lastOpenFiles": [
-    "Computing/AWS/DynamoDB/93. Amazon DynamoDB.md",
     "Computing/AWS/DynamoDB/DynamoDB LSI and GSI.md",
+    "Computing/AWS/DynamoDB/94. DynamoDB Partitions and Primary Keys.md",
+    "Computing/AWS/DynamoDB/Amazon DynamoDB.md",
+    "Computing/AWS/DynamoDB/93. Amazon DynamoDB.md",
     "Physics/Electric Field/Electric Field Strength and Charge Equation.md",
     "Computing/AWS/DynamoDB/102. DynamoDB LSI and GSI.md",
     "Physics/Electric Field/Electric Field Strength and Force Equation.md",
     "Computing/AWS/DynamoDB/104. DynamoDB Optimistic Locking and Conditional Updates.md",
     "User Guide/Context.md",
     "Math/Ellipse/Ellipse.md",
     "Physics/Electric Field/Electric Field.md",
-    "Computing/AWS/DynamoDB/94. DynamoDB Partitions and Primary Keys.md",
     "Computing/AWS/DynamoDB/101. [HOL] Searching DynamoDB - Query API.md",
     "Math/Ellipse/Ellipse Equation.md",
     "User Guide",
@@ -195,7 +195,6 @@
     "Computing/AWS/DynamoDB/107. Amazon DynamoDB Accelerator (DAX).md",
     "Computing/AWS/DynamoDB/106. Amazon DynamoDB Streams.md",
     "Computing/AWS/DynamoDB/105. [HOL] Adding a Time to Live (TTL) to Items.md",
-    "Computing/AWS/DynamoDB/103. [HOL] Create LSI and GSI.md",
     "Computing/AWS/DynamoDB",
     "Computing/AWS/Section 8 - DynamoDB/files",
     "Computing/AWS/Section 8 - DynamoDB",

diff --git a/...uting/AWS/DynamoDB/93. Amazon DynamoDB.md → ...Computing/AWS/DynamoDB/Amazon DynamoDB.md b/...uting/AWS/DynamoDB/93. Amazon DynamoDB.md → ...Computing/AWS/DynamoDB/Amazon DynamoDB.md
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -2,8 +2,15 @@
     color: #EE0F0F;
 }
 
+
 hr {
     border: none !important;
     height: 4px;
     background-color: #333;  
 }
+
+.thin {
+    border: none !important;
+    height: 1px;
+}
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -33,7 +33,7 @@ nav:
     - Flashcards:
         - Flashcards Overview: flashcards/flashcards.md
         - Question & Answer Cards: flashcards/qanda-cards.md
-        - Cloze Cards: flashcards/cloze-cards/basic-cloze-cards.md
+        - Cloze Cards: flashcards/basic-cloze-cards.md
         - Organizing into Decks: flashcards/decks.md
         - Reviewing & Cramming: flashcards/reviewing.md
         - Statistics: flashcards/statistics.md
@@ -72,8 +72,8 @@ markdown_extensions:
     - attr_list
     - footnotes
     - pymdownx.emoji:
-          emoji_index: !!python/name:materialx.emoji.twemoji
-          emoji_generator: !!python/name:materialx.emoji.to_svg
+          emoji_index: !!python/name:material.extensions.emoji.twemoji
+          emoji_generator: !!python/name:material.extensions.emoji.to_svg
     - md_in_html
 
 extra_css: