Ready for review

.gitignore

@@ -29,8 +29,8 @@ tests/e2e/vault/
 site/
 venv/
 .venv/
-docs/en/media/~*
-docs/en/user-doco-vault/.obsidian/plugins/obsidian-spaced-repetition-beta
+docs/docs/en/media/~*
+docs/docs/en/user-doco-vault/.obsidian/plugins/obsidian-spaced-repetition-beta
 
 # env
 env.sh

docs/docs/en/flashcards/basic-cloze-cards.md

@@ -19,11 +19,11 @@ The first female prime minister of Australia was ==Julia Gillard==
 !!! note "Displayed when reviewed"
  <div class="grid" markdown>
 
- !!! tip "Card Front"
+ !!! tip "Initial View"
 
   The first female prime minister of Australia was [...]
 
- !!! tip "Card Back"
+ !!! tip "After `Show Answer` Clicked"
 
   The first female prime minister of Australia was Julia Gillard
 
@@ -42,17 +42,17 @@ The first female ==prime minister== of Australia was ==Julia Gillard==
 !!! note ""
  <div class="grid" markdown>
 
- !!! tip "Card 1 Front"
+ !!! tip "Card 1 Initial View"
 
   The first female [...] of Australia was Julia Gillard
 
- !!! tip "Card 2 Front"
+ !!! tip "Card 2 Initial View"
 
   The first female prime minister of Australia was [...]
 
  </div>
 
-!!! tip "Card Back (same for both cards)"
+!!! tip "After `Show Answer` Clicked (same for both cards)"
 
  The first female prime minister of Australia was Julia Gillard
 
@@ -61,9 +61,10 @@ These two cards are considered sibling cards. See [sibling cards](flashcards-ove
 
 ## Cloze Delimiter
 
-The cloze delimiter can be modified in settings, e.g. to `**`, or curly braces `{{text in curly braces}}`.
+The cloze delimiter can be modified in [settings](../user-options.md#flashcard-review), e.g. to `**`, or curly braces `{{text in curly braces}}`.
 
 
+<!-- 
 ## Cloze Hints
 
 Hints can be included for any of the cloze deletions, using the `^[text of hint]` syntax. For example:
@@ -100,8 +101,10 @@ and this also ==in group 1==[^1]
 
 !!! warning
  When using deletion groups, every cloze deletion must include the group number
+ -->
 
 ## Anki style
 
-!!! warning "Fix documentation"
- Anki style `{{c1:This text}} would {{c2:generate}} {{c1:2 cards}}` cloze deletions are not currently supported. This feature is being tracked [here](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/93/).
+!!! warning
+ Anki style `{{c1:This text}} would {{c2:generate}} {{c1:2 cards}}` cloze deletions are not currently supported. This feature is being tracked [here](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/93/).
+

docs/docs/en/flashcards/decks.md

@@ -1,9 +1,7 @@
 # Organizing into Decks
 
-![Screenshot from 2021-06-05 19-28-24](https://user-images.githubusercontent.com/43380836/120922211-78603400-c6d0-11eb-9d09-bdd5df1c9112.png)
+![flashcard-decks-1](https://github.com/user-attachments/assets/a207b0f6-b064-443c-9c55-540681b10891)
 
-!!! note
- The green and blue counts on the right of each deck name represent due and new cards respectively.
 
 ## Using Obsidian Tags
 

docs/docs/en/flashcards/flashcards-overview.md

@@ -13,16 +13,16 @@ Two types of flashcards are supported:
 
  [Question & Answer](qanda-cards.md) flashcards are ones where the flashcard text contains both the question text and answer text.
 
- ---
- ![flashcard-qanda-example](https://github.com/user-attachments/assets/95f5ae9a-3093-400e-9ef4-a0ec829eabf7)
+ <hr class="thin">
+ ![flashcard-qanda-example](https://github.com/user-attachments/assets/65639d80-b249-4b16-ae40-c2af011c6aab)
 
 !!! note "Cloze"
 
  [Cloze](basic-cloze-cards.md) flashcards are ones where the flashcard text identifies parts of the text (e.g. a word or phrase) that is hidden 
  when the front of the card is shown. <br/>
  The hidden text is known as a `cloze deletion`.
- ---
- ![flashcard-cloze-example](https://github.com/user-attachments/assets/47f7403b-a34f-4458-a078-417fa1ea75c6)
+ <hr class="thin">
+ ![flashcard-cloze-example](https://github.com/user-attachments/assets/9fb12f2e-9b81-45d9-9097-7f1e3d97ae5a)
 </div>
 
 !!! tip
@@ -53,9 +53,7 @@ Flashcard Type | Cards Defined
 
 If there are multiple cards defined by a single flashcard, those cards are known as `sibling` cards.
 
-A special scheduling option is available for the review of sibling cards.
-
-If the [Bury sibling cards until the next day]( ../user-options.md#flashcard-review)) setting is turned on, 
+A special scheduling option is available for the review of sibling cards. If the [Bury sibling cards until the next day]( ../user-options.md#flashcard-review) setting is turned on, 
 only one sibling card is available for review on a single day.
 
 ---

docs/docs/en/flashcards/qanda-cards.md

@@ -18,6 +18,7 @@ the question goes on this side::answer goes here!
 ```
 
 !!! note "Displayed when reviewed"
+
  <div class="grid" markdown>
 
  !!! tip "Card Front"
@@ -45,23 +46,23 @@ info 1:::info 2
 !!! note "Card 1"
  <div class="grid" markdown>
 
- !!! tip "Card 1 Front"
+ !!! tip "Front"
 
   info 1
 
- !!! tip "Card 1 Back"
+ !!! tip "Back"
 
   info 2
 
  </div>
 
 !!! note "Card 2"
  <div class="grid" markdown>
- !!! tip "Card 2 Front"
+ !!! tip "Front"
 
   info 2
 
- !!! tip "Card 2 Back"
+ !!! tip "Back"
 
   info 1
 
@@ -131,13 +132,13 @@ These can also span over multiple lines as long as both sides "touch" the `??`:
 !!! note "Card 1"
  <div class="grid" markdown>
 
- !!! tip "Card 1 Front"
+ !!! tip "Front"
 
   info 1A <br/>
   info 1B <br/>
   info 1C
 
- !!! tip "Card 1 Back"
+ !!! tip "Back"
 
   info 2A <br/>
   info 2B
@@ -146,12 +147,12 @@ These can also span over multiple lines as long as both sides "touch" the `??`:
 
 !!! note "Card 2"
  <div class="grid" markdown>
- !!! tip "Card 2 Front"
+ !!! tip "Front"
 
   info 2A <br/>
   info 2B
 
- !!! tip "Card 2 Back"
+ !!! tip "Back"
 
   info 1A <br/>
   info 1B <br/>

docs/docs/en/flashcards/reviewing.md

@@ -21,7 +21,7 @@ A key part of spaced repetition learning is being shown the front of cards to te
 
 Although you may want to review or cram all cards across all decks, you often may wish to do so on only a subset of decks.
 
-![review-deck](https://github.com/user-attachments/assets/07c9f436-6b2a-43b5-b6f6-339bcd1cadfa)
+![flashcard-decks-1](https://github.com/user-attachments/assets/a207b0f6-b064-443c-9c55-540681b10891)
 
 !!! note "All subdecks included"
 
@@ -31,15 +31,16 @@ Although you may want to review or cram all cards across all decks, you often ma
 ### Operation
 
 
-# | Name | Description
-- | - | -
-1 | Edit | Edit the flashcard text
-2 | Reset | Reset the review schedule information - the review interval is set to 1 day, and the ease is set to the default value
-3 | Info | Shows the scheduling information for the card
-4 | Skip | Skip the current card without reviewing
-
 ![review-operation](https://github.com/user-attachments/assets/d8f438dc-f1f0-43c4-a752-a5eeb64346e4)
 
+!!! note ""
+ # | Name | Description
+ - | - | -
+ 1 | Edit | Edit the flashcard text
+ 2 | Reset | Reset the review schedule information - the review interval is set to 1 day, and the ease is set to the default value
+ 3 | Info | Shows the scheduling information for the card
+ 4 | Skip | Skip the current card without reviewing
+
 ### Context
 
 If the parent note has heading(s), the flashcard will have a title containing the context.

docs/docs/en/index.md

@@ -46,11 +46,11 @@ Fight the forgetting curve by reviewing flashcards & notes using spaced repetiti
  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/>
+ 4. `Flashcard Review Icon` 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.
+ 8. `Spaced Repetition Status Area` The number of notes and flashcards currently due for review. Click to SOMETHING.
 
 
 <video controls>

docs/docs/en/notes.md

@@ -5,49 +5,75 @@
 
 ## Getting started
 
-Tag any notes that you'd like to review as `#review`. This default tag can be changed in the [settings](user-options.md#note-settings). (You can also use multiple tags)
 
+Tag any markdown files for review with the `note review` tag, which by default is `#review`. 
+
+The note will appear under `New` in the `Note Review Queue` in the right pane.
+
+!!! note
+ When you tag a note with `#review` the note doesn't immediately appear in the review queue.
+ You will need to first click on the `Flashcard Review Icon` or the `Spaced Repetition Status Area`
+ for the queue to update
+
 ## Note Review Queue
 
+![note-review-queue](https://github.com/user-attachments/assets/c0e1d09c-610f-4775-b532-ab78369b117a)
 
+!!! note ""
 
-## New Notes
+ 1. The Note Review Queue <br/>
+ 2. The `Note Review Deck` for tag `#review` <br/>
+ 3. The new notes - i.e. those tagged with `#review` but have yet to be reviewed <br/>
+ 4. The notes scheduled for review on August 1 <br/>
+ 5. The notes scheduled for review on August 31 <br/>
 
-All "new" notes are listed under `New` on the right pane (Review Queue). Like so:
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/new_notes.png" />
 
 ## Reviewing
 
-Open the file & review it. Once done, choose either the `Review: Easy`, `Review: Good`, or the `Review: Hard` option on the file menu (the three dots). The `Easy`, `Good`, or `Hard` depend on how well you comprehend the material being reviewed.
+Open a file, read & review it. Once done, choose either the `Review: Easy`, `Review: Good`, or the `Review: Hard` option on the file menu (the three dots). Select `Easy`, `Good`, or `Hard` depend on how well you comprehend the material being reviewed.
+
+![file-three-dots-menu](https://github.com/user-attachments/assets/5f37ab88-30f9-477d-b39c-eb86ba15abdb)
+
+Alternatively, you can right click on the file within the note review queue, and access the same options:
+
+![note-review-queue-context-menu](https://github.com/user-attachments/assets/d4affa19-5126-45f8-bf3c-0079d2a8a597)
+
+The note will then be scheduled appropriately by the [learning algorithm](algorithms.md), and the markdown file updated:
+
+![note-frontmatter](https://github.com/user-attachments/assets/b9744f50-c897-46ad-ab34-1bbc55796b57)
+
+### Keyboard Shortcuts
+
+The `Easy`, `Good`, and `Hard` review result can also be selected from the plugin's [command list](plugin-commands.md).
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/more_options.png" />
+This is less practical than the methods described above, but does enable the definition of keyboard shortcuts.
+You can create custom hotkeys for the review result in `Settings -> HotKeys`. 
 
-Alternatively, you can right click on the file and access the same options:
+### Selecting a Note for Review
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/file_context_menu.png" />
+- Open a note via the standard Obsidian features
+- Doubled click on a note title from the Note Review Queue
+- Click on the `Spaced Repetition Status Area` in the status bar at the bottom of the screen
+- Select the command [Open a note to review review](plugin-commands.md)
 
-The note will then be scheduled appropriately:
+There are also the following relevant options:
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/scheduled.png" />
+- [Open a random note for review](user-options.md)
+- [Open next note automatically after a review](user-options.md)
 
-### Faster Review
+## Multiple Note Review Decks
 
-Commands to open a note for review, and making review responses are provided. You can create custom hotkeys for them in `Settings -> HotKeys`. This allows for much faster review.
+By default, there is a single review deck called `#review`.
 
-### Review Settings
+This default tag can be changed in the [settings](user-options.md#note-settings). Multiple review decks can also be specified.
 
-Available settings are:
+## Spaced Repetition Status Area
 
-- Choosing whether to open a note at random or the most important note
-- Choosing whether to open the next note automatically after reviewing another
+`Review: N note(s)` on the status bar at the bottom of the screen shows how many notes one has to review today (Today's notes + overdue notes). 
 
-## Scheduled notes
+Clicking on that opens one of the notes for review.
 
-`Review: N due` on the status bar at the bottom of the screen shows how many notes one has to review today (Today's notes + overdue notes). Clicking on that opens one of the notes for review.
 
-Alternatively, one can use the `Open a note for review` command.
 
-## Review Queue
 
-- Daily review entries are sorted by importance (PageRank)

docs/user-doco-vault/en/.obsidian/app.json

@@ -1,3 +1,4 @@
 {
- "promptDelete": false
+ "promptDelete": false,
+ "alwaysUpdateLinks": true
 }

docs/user-doco-vault/en/.obsidian/plugins/obsidian-spaced-repetition-beta/data.json

@@ -10,7 +10,7 @@
  "convertFoldersToDecks": false,
  "cardCommentOnSameLine": true,
  "burySiblingCards": true,
- "showContextInCards": false,
+ "showContextInCards": true,
  "flashcardHeightPercentage": 80,
  "flashcardWidthPercentage": 40,
  "randomizeCardOrder": null,