diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..1f93631 --- /dev/null +++ b/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 + +
About CVSASome information you might want to know about..
ArchitectureThe technical details about how CVSA was built.Broken link
API DocDocumentation about APIs provided by CVSA.Broken link
diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md new file mode 100644 index 0000000..3c3cbd3 --- /dev/null +++ b/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) diff --git a/doc/about/scope-of-inclusion.md b/doc/about/scope-of-inclusion.md new file mode 100644 index 0000000..a32d1a1 --- /dev/null +++ b/doc/about/scope-of-inclusion.md @@ -0,0 +1,2 @@ +# Scope of Inclusion + diff --git a/doc/about/this-project.md b/doc/about/this-project.md new file mode 100644 index 0000000..6db29ee --- /dev/null +++ b/doc/about/this-project.md @@ -0,0 +1,2 @@ +# About CVSA Project + diff --git a/doc/api-doc/catalog.md b/doc/api-doc/catalog.md new file mode 100644 index 0000000..2a57a78 --- /dev/null +++ b/doc/api-doc/catalog.md @@ -0,0 +1,4 @@ +# Catalog + +* [**Songs**](songs.md) + diff --git a/doc/api-doc/songs.md b/doc/api-doc/songs.md new file mode 100644 index 0000000..d62d620 --- /dev/null +++ b/doc/api-doc/songs.md @@ -0,0 +1,2 @@ +# Songs + diff --git a/doc/architecure/overview.md b/doc/architecure/overview.md new file mode 100644 index 0000000..d80036e --- /dev/null +++ b/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.