From 50a9b83d04f8a0a44f2404b1c7cd1b09aec4825c Mon Sep 17 00:00:00 2001
From: alikia2x <alikia2x@outlook.com>
Date: Tue, 11 Feb 2025 06:07:54 +0800
Subject: [PATCH] doc: re-structured the doc folder

---
 doc/architecure/song-type.md             | 24 ------------------------
 doc/{ => en}/README.md                   |  2 +-
 doc/{ => en}/SUMMARY.md                  |  0
 doc/{ => en}/about/scope-of-inclusion.md |  0
 doc/{ => en}/about/this-project.md       |  0
 doc/{ => en}/api-doc/catalog.md          |  0
 doc/{ => en}/api-doc/songs.md            |  0
 doc/{ => en}/architecure/overview.md     |  0
 8 files changed, 1 insertion(+), 25 deletions(-)
 delete mode 100644 doc/architecure/song-type.md
 rename doc/{ => en}/README.md (75%)
 rename doc/{ => en}/SUMMARY.md (100%)
 rename doc/{ => en}/about/scope-of-inclusion.md (100%)
 rename doc/{ => en}/about/this-project.md (100%)
 rename doc/{ => en}/api-doc/catalog.md (100%)
 rename doc/{ => en}/api-doc/songs.md (100%)
 rename doc/{ => en}/architecure/overview.md (100%)

diff --git a/doc/architecure/song-type.md b/doc/architecure/song-type.md
deleted file mode 100644
index 557a6e8..0000000
--- a/doc/architecure/song-type.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# Song Type
-
-The Unrelated type refers specifically to videos that are not in our [Scope of Inclusion](../about/scope-of-inclusion).
-
-## Table: `songs`
-
-The `type` column used in the `songs` table.
-
-| Type | Description            |
-| ---- | ---------------------- |
-| 0    | Unrelated              |
-| 1    | Original               |
-| 2    | Cover                  |
-| 3    | Remix                  |
-| 4    | Instrumental           |
-| 10   | Others                 |
-
-## Table: `labelling_result`
-
-| Label | Description            |
-| ----- | ---------------------- |
-|   0   | AI tagged: Unrelated   |
-|   1   | AI tagged: Original    |
-|   2   | AI tagged: Cover/Remix |
diff --git a/doc/README.md b/doc/en/README.md
similarity index 75%
rename from doc/README.md
rename to doc/en/README.md
index 1f93631..88bed9b 100644
--- a/doc/README.md
+++ b/doc/en/README.md
@@ -21,4 +21,4 @@ This doc contains various information about the CVSA project, including technica
 
 ### Jump right in
 
-<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>About CVSA</strong></td><td>Some information you might want to know about.</td><td></td><td></td><td><a href="./">.</a></td></tr><tr><td><strong>Architecture</strong></td><td>The technical details about how CVSA was built.</td><td></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>API Doc</strong></td><td>Documentation about APIs provided by CVSA.</td><td></td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
+<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>About CVSA</strong></td><td>Some information you might want to know about.</td><td></td><td></td><td><a href="./">.</a></td></tr><tr><td><strong>Architecture</strong></td><td>The technical details about how CVSA was built.</td><td></td><td></td><td><a href="../broken-reference/">broken-reference</a></td></tr><tr><td><strong>API Doc</strong></td><td>Documentation about APIs provided by CVSA.</td><td></td><td></td><td><a href="../broken-reference/">broken-reference</a></td></tr></tbody></table>
diff --git a/doc/SUMMARY.md b/doc/en/SUMMARY.md
similarity index 100%
rename from doc/SUMMARY.md
rename to doc/en/SUMMARY.md
diff --git a/doc/about/scope-of-inclusion.md b/doc/en/about/scope-of-inclusion.md
similarity index 100%
rename from doc/about/scope-of-inclusion.md
rename to doc/en/about/scope-of-inclusion.md
diff --git a/doc/about/this-project.md b/doc/en/about/this-project.md
similarity index 100%
rename from doc/about/this-project.md
rename to doc/en/about/this-project.md
diff --git a/doc/api-doc/catalog.md b/doc/en/api-doc/catalog.md
similarity index 100%
rename from doc/api-doc/catalog.md
rename to doc/en/api-doc/catalog.md
diff --git a/doc/api-doc/songs.md b/doc/en/api-doc/songs.md
similarity index 100%
rename from doc/api-doc/songs.md
rename to doc/en/api-doc/songs.md
diff --git a/doc/architecure/overview.md b/doc/en/architecure/overview.md
similarity index 100%
rename from doc/architecure/overview.md
rename to doc/en/architecure/overview.md