merge: from branch 'gitbook'

doc/README.md

@@ -0,0 +1,24 @@
+---
+icon: hand-wave
+layout:
+  title:
+    visible: true
+  description:
+    visible: false
+  tableOfContents:
+    visible: false
+  outline:
+    visible: false
+  pagination:
+    visible: false
+---
+
+# Welcome
+
+Welcome to the CVSA Documentation!
+
+This doc contains various information about the CVSA project, including technical architecture, tutorials for visitors, etc.
+
+### 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>

doc/SUMMARY.md

@@ -0,0 +1,17 @@
+# Table of contents
+
+* [Welcome](README.md)
+
+## About
+
+* [About CVSA Project](about/this-project.md)
+* [Scope of Inclusion](about/scope-of-inclusion.md)
+
+## Architecure
+
+* [Overview](architecure/overview.md)
+
+## API Doc
+
+* [Catalog](api-doc/catalog.md)
+* [Songs](api-doc/songs.md)

doc/about/scope-of-inclusion.md

@@ -0,0 +1,2 @@
+# Scope of Inclusion
+

doc/about/this-project.md

@@ -0,0 +1,2 @@
+# About CVSA Project
+

doc/api-doc/catalog.md

@@ -0,0 +1,4 @@
+# Catalog
+
+* [**Songs**](songs.md)
+

doc/api-doc/songs.md

@@ -0,0 +1,2 @@
+# Songs
+

doc/architecure/overview.md

@@ -0,0 +1,18 @@
+---
+icon: globe-pointer
+layout:
+  title:
+    visible: true
+  description:
+    visible: false
+  tableOfContents:
+    visible: true
+  outline:
+    visible: true
+  pagination:
+    visible: true
+---
+
+# Overview
+
+Automation is the biggest highlight of CVSA's technical design. To achieve this, we use a message queue powered by [BullMQ](https://bullmq.io/) to concurrently process various tasks in the data collection life cycle.