From 72e7535f5a95086eab3b2768f96235d18ef3cd26 Mon Sep 17 00:00:00 2001
From: Ronny Zulaikha <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 6 Sep 2024 18:14:16 +1000
Subject: [PATCH] Fixed docs references for: Major reworking of the
 documentation (#1051)

* Fixed: Completed updating references to folder docs to docs/docs

* Restored new line
---
 CHANGELOG.md                 | 2 +-
 CONTRIBUTING.md              | 2 +-
 docs/docs/en/contributing.md | 4 ++--
 docs/docs/zh/contributing.md | 4 ++--
 package.json                 | 2 +-
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1cc39a66..1fcfbd40 120000
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1 +1 @@
-docs/changelog.md
+docs/docs/changelog.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9815d5bd..f6af8f1f 120000
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1 +1 @@
-docs/en/contributing.md
+docs/docs/en/contributing.md
diff --git a/docs/docs/en/contributing.md b/docs/docs/en/contributing.md
index e948791b..8deacab4 100644
--- a/docs/docs/en/contributing.md
+++ b/docs/docs/en/contributing.md
@@ -117,7 +117,7 @@ Please note that:
 The documentation consists of Markdown files which [MkDocs](https://www.mkdocs.org/) converts to static web pages.
 Specifically, this project uses [MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/).
 
-These files reside in `docs/` in the respective language's folder. For instance, English docs are located in `docs/en/`.
+These files reside in `docs/docs/` in the respective language's folder. For instance, English docs are located in `docs/docs/en/`.
 
 The docs are served on [https://www.stephenmwangi.com/obsidian-spaced-repetition/](https://www.stephenmwangi.com/obsidian-spaced-repetition/).
 
@@ -142,7 +142,7 @@ For larger diffs, it's important that you check how your docs look like as expla
 
 ### Translating Documentation
 
-1. Create a folder for your language in `docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
+1. Create a folder for your language in `docs/docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
 2. Add the code from (1) to the MkDocs configuration (`mkdocs.yml` - `plugins.i18n.languages`).
 3. Copy the files from the English (`en`) folder into the new folder.
 4. Translate then open a pull request.
diff --git a/docs/docs/zh/contributing.md b/docs/docs/zh/contributing.md
index 1bdd584a..ef16dda5 100644
--- a/docs/docs/zh/contributing.md
+++ b/docs/docs/zh/contributing.md
@@ -96,7 +96,7 @@ Please note that:
 The documentation consists of Markdown files which [MkDocs](https://www.mkdocs.org/) converts to static web pages.
 Specifically, this project uses [MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/).
 
-These files reside in `docs/` in the respective language's folder. For instance, English docs are located in `docs/en/`.
+These files reside in `docs/docs/` in the respective language's folder. For instance, English docs are located in `docs/docs/en/`.
 
 The docs are served on [https://www.stephenmwangi.com/obsidian-spaced-repetition/](https://www.stephenmwangi.com/obsidian-spaced-repetition/).
 
@@ -121,7 +121,7 @@ For larger diffs, it's important that you check how your docs look like as expla
 
 ### Translating Documentation
 
-1. Create a folder for your language in `docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
+1. Create a folder for your language in `docs/docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
 2. Add the code from (1) to the MkDocs configuration (`mkdocs.yml` - `plugins.i18n.languages`).
 3. Copy the files from the English (`en`) folder into the new folder.
 4. Translate then open a pull request.
diff --git a/package.json b/package.json
index e96b28e7..7b1c32a3 100644
--- a/package.json
+++ b/package.json
@@ -9,7 +9,7 @@
         "format": "npx prettier --write .",
         "lint": "npx prettier --check . && npx eslint src/",
         "test": "jest",
-        "changelog": "auto-changelog --template=compact --package && npx prettier --write docs/changelog.md",
+        "changelog": "auto-changelog --template=compact --package && npx prettier --write docs/docs/changelog.md",
         "e2e": "make setup_e2e && wdio run ./wdio.conf.js"
     },
     "keywords": [