chore: structure docs & utils directories

st3v3nmw · Sep 22, 2024 · a4ea84b · a4ea84b
1 parent 150523b
commit a4ea84b
Show file tree

Hide file tree

Showing 137 changed files with 688 additions and 24,352 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,6 +30,7 @@ site/
 venv/
 .venv/
 docs/docs/en/media/~*
+docs/vaults/*/.obsidian
 .obsidian/plugins/obsidian-spaced-repetition-beta/*
 
 # env

diff --git a/.prettierignore b/.prettierignore
@@ -2,5 +2,5 @@ build
 coverage
 node_modules
 pnpm-lock.yaml
+docs/vaults/
 tests/vaults/
-docs/user-doco-vault/
diff --git a/docs/docs/en/algorithms.md b/docs/docs/en/algorithms.md
@@ -21,7 +21,7 @@ A learning algorithm is a formula that determines when a note or flashcard shoul
 !!! warning
 
  Note that this hasn't been updated in a while,
- please see the [code](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/src/scheduling.ts).
+ please see the [code](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/src/algorithms/osr/srs-algorithm-osr.ts).
 
 - `if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_ease` - `link_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64))` (cater for uncertainty)
  - The importance of the different concepts/notes is determined using the PageRank algorithm (not all notes are created equal xD)

diff --git a/docs/docs/en/flashcards/basic-cloze-cards.md b/docs/docs/en/flashcards/basic-cloze-cards.md
@@ -1,6 +1,6 @@
 # Basic Cloze Cards
 
-With [Single & Multiline Cards](../flashcards/qanda-cards.md) the text of both the front and back of each card is specified.
+With [Single & Multiline Cards](../flashcards/q-and-a-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/docs/en/flashcards/cards-with-blank-lines.md b/docs/docs/en/flashcards/cards-with-blank-lines.md
@@ -1,6 +1,6 @@
 # Including Blank Lines in Flashcards
 
-By default, [Multi-line Basic](qanda-cards.md#multi-line-basic), [Multi-line Bidirectional](qanda-cards.md#multi-line-bidirectional)
+By default, [Multi-line Basic](q-and-a-cards.md#multi-line-basic), [Multi-line Bidirectional](q-and-a-cards.md#multi-line-bidirectional)
 and [Cloze](basic-cloze-cards.md) type flashcards recognize a blank line as the end of the flashcard text.
 This means that blank lines can not be included within the text.
 

diff --git a/docs/docs/en/flashcards/decks.md b/docs/docs/en/flashcards/decks.md
@@ -73,4 +73,4 @@ The plugin will automatically search for folders that contain flashcards & use t
 
 e.g. `Folder/sub-folder/sub-sub-folder` ⇔ `Deck/sub-deck/sub-sub-deck`.
 
-This is an alternative to the tagging option and can be enabled in [settings](../user-options.md#tags--folders).
+This is an alternative to the tagging option and can be enabled in [settings](../user-options.md#tags-folders).
diff --git a/docs/docs/en/flashcards/flashcards-overview.md b/docs/docs/en/flashcards/flashcards-overview.md
@@ -11,7 +11,7 @@ Two types of flashcards are supported:
 
 !!! note "Question & Answer"
 
- [Question & Answer](qanda-cards.md) flashcards are ones where the flashcard text contains both the question text and answer text.
+ [Question & Answer](q-and-a-cards.md) flashcards are ones where the flashcard text contains both the question text and answer text.
 
  <hr class="thin">
  ![flashcard-qanda-example](https://github.com/user-attachments/assets/65639d80-b249-4b16-ae40-c2af011c6aab)
@@ -45,13 +45,13 @@ The `flashcard text` is text that defines the type and content of a card (or a s
 For some flashcard types, the flashcard text defines a single card. For other flashcard types, multiple
 cards are defined.
 
-| Flashcard Type | Cards Defined |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| [Single-line Basic](qanda-cards.md#single-line-basic) | flashcard defines the front and back of a single card. |
-| [Single-line Bidirectional](qanda-cards.md#single-line-bidirectional) | flashcard defines two cards. |
-| [Multi-line Basic](qanda-cards.md#multi-line-basic) | flashcard defines the front and back of a single card. |
-| [Multi-line Bidirectional](qanda-cards.md#multi-line-bidirectional) | flashcard defines two cards. |
-| [Cloze](basic-cloze-cards.md) | flashcard defines multiple cards, the number of cards based on the number of cloze deletions. |
+| Flashcard Type  | Cards Defined |
+| ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| [Single-line Basic](q-and-a-cards.md#single-line-basic) | flashcard defines the front and back of a single card. |
+| [Single-line Bidirectional](q-and-a-cards.md#single-line-bidirectional) | flashcard defines two cards. |
+| [Multi-line Basic](q-and-a-cards.md#multi-line-basic) | flashcard defines the front and back of a single card. |
+| [Multi-line Bidirectional](q-and-a-cards.md#multi-line-bidirectional) | flashcard defines two cards. |
+| [Cloze](basic-cloze-cards.md)  | flashcard defines multiple cards, the number of cards based on the number of cloze deletions. |
 
 ### Sibling Cards
 

diff --git a/docs/docs/en/flashcards/statistics.md b/docs/docs/en/flashcards/statistics.md
@@ -6,7 +6,7 @@ The statistics section can be accessed using the `View Statistics` command.
 
 Stats on the number of cards due in the future.
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/stats_forecast.png" />
+<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/docs/media/en/stats_forecast.png" />
 
 ### Intervals
 

diff --git a/docs/docs/en/index.md b/docs/docs/en/index.md
@@ -44,7 +44,7 @@ Fight the forgetting curve by reviewing flashcards & notes using spaced repetiti
  3. Display the Obsidian command dialog to access the plugin [commands](plugin-commands.md)<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/>
+ 6. A [single line question](flashcards/q-and-a-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. `Spaced Repetition Status Area` The number of notes and flashcards currently due for review. Click to [open a note for review](notes.md#selecting-a-note-for-review).
 
@@ -69,5 +69,3 @@ You can easily install the plugin from Obsidian's community plugin section in th
 ## Support
 
 <a href='https://ko-fi.com/M4M44DEN6' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi3.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
-
-<a href="https://jb.gg/OpenSourceSupport" target="_blank"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" height='128' style='border:0px;height:128px;' alt="JetBrains Logo (Main) logo."></a>
diff --git a/docs/docs/stylesheets/extra.css → docs/docs/extra.css b/docs/docs/stylesheets/extra.css → docs/docs/extra.css
diff --git a/docs/docs/assets/favicon.ico → docs/docs/favicon.ico b/docs/docs/assets/favicon.ico → docs/docs/favicon.ico
diff --git a/docs/docs/zh/algorithms.md b/docs/docs/zh/algorithms.md
@@ -5,7 +5,7 @@
 !!! 警告
 
  该条目长时间未更新,
- 请注意阅读 [源代码](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/src/scheduling.ts).
+ 请注意阅读 [源代码](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/src/algorithms/osr/srs-algorithm-osr.ts).
 
 (除 PageRanks 之外，卡片复习采用相同规划算法)
 

diff --git a/docs/docs/zh/flashcards.md b/docs/docs/zh/flashcards.md
@@ -225,7 +225,7 @@ Canada::Ottawa
 
 计算将要到期的卡片数量。
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/stats_forecast.png" />
+<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/docs/media/en/stats_forecast.png" />
 
 ### 复习间隔
 

diff --git a/docs/docs/zh/index.md b/docs/docs/zh/index.md
@@ -49,5 +49,3 @@ Fight the forgetting curve & note aging by reviewing flashcards & notes using sp
 ### 赞助
 
 <a href='https://ko-fi.com/M4M44DEN6' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi3.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
-
-<a href="https://jb.gg/OpenSourceSupport" target="_blank"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" height='128' style='border:0px;height:128px;' alt="JetBrains Logo (Main) logo."></a>
diff --git a/docs/docs/zh/notes.md b/docs/docs/zh/notes.md
@@ -13,21 +13,21 @@
 
 新笔记将展示在右栏的 `新` （复习序列）中，如图：
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/new_notes.png" />
+<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/docs/media/en/new_notes.png" />
 
 ## 复习
 
 打开笔记即可复习。在菜单中选择 `复习: 简单`，`复习: 记得` 或 `复习: 较难`。 选择 `简单`，`记得` 还是 `较难` 取决于你对复习材料的理解程度。
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/more_options.png" />
+<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/docs/media/en/more_options.png" />
 
 在文件上右击可以调出相同选项：
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/file_context_menu.png" />
+<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/docs/media/en/file_context_menu.png" />
 
 笔记将被添加到复习队列中：
 
-<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/assets/scheduled.png" />
+<img src="https://raw.githubusercontent.com/st3v3nmw/obsidian-spaced-repetition/master/docs/media/en/scheduled.png" />
 
 ### 快速复习
 

diff --git a/assets/file_context_menu.png → docs/media/en/file_context_menu.png b/assets/file_context_menu.png → docs/media/en/file_context_menu.png
diff --git a/assets/more_options.png → docs/media/en/more_options.png b/assets/more_options.png → docs/media/en/more_options.png
diff --git a/assets/new_notes.png → docs/media/en/new_notes.png b/assets/new_notes.png → docs/media/en/new_notes.png
diff --git a/assets/scheduled.png → docs/media/en/scheduled.png b/assets/scheduled.png → docs/media/en/scheduled.png
diff --git a/assets/stats_forecast.png → docs/media/en/stats_forecast.png b/assets/stats_forecast.png → docs/media/en/stats_forecast.png
diff --git a/docs/user-doco-vault/en/.obsidian/app.json b/docs/user-doco-vault/en/.obsidian/app.json
diff --git a/docs/user-doco-vault/en/.obsidian/appearance.json b/docs/user-doco-vault/en/.obsidian/appearance.json
diff --git a/docs/user-doco-vault/en/.obsidian/community-plugins.json b/docs/user-doco-vault/en/.obsidian/community-plugins.json
diff --git a/docs/user-doco-vault/en/.obsidian/core-plugins-migration.json b/docs/user-doco-vault/en/.obsidian/core-plugins-migration.json
diff --git a/docs/user-doco-vault/en/.obsidian/core-plugins.json b/docs/user-doco-vault/en/.obsidian/core-plugins.json
diff --git a/docs/user-doco-vault/en/.obsidian/graph.json b/docs/user-doco-vault/en/.obsidian/graph.json
diff --git a/docs/user-doco-vault/en/.obsidian/plugins/obsidian-spaced-repetition/data.json b/docs/user-doco-vault/en/.obsidian/plugins/obsidian-spaced-repetition/data.json