Docusaurus (#6)

Begin migration to docusaurus (reset all)

docs/README.md

@@ -24,18 +24,3 @@ $ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docs/getting-started.md

@@ -0,0 +1,11 @@
+---
+sidebar_position: 1
+---
+
+# Getting Started
+
+Let's discover **dRAGon in less than 5 minutes**.
+
+## Launching dRAGon
+
+Soon

docs/docusaurus.config.ts

@@ -5,7 +5,7 @@ import type * as Preset from '@docusaurus/preset-classic';
 const config: Config = {
   title: 'dRAGon',
   tagline: 'Dynamic Retrieval Augmented Generation for Optimized Nimble',
-  favicon: 'img/favicon.ico',
+  favicon: '/favicon.ico',
   url: 'https://dragon.okinawa',
   baseUrl: '/',
   organizationName: 'isontheline',
@@ -37,17 +37,17 @@ const config: Config = {
       title: 'dRAGon',
       logo: {
         alt: 'dRAGon',
-        src: 'img/logo.svg',
+        src: 'img/dragon_okinawa_icon.png',
       },
       items: [
         {
           type: 'docSidebar',
           sidebarId: 'tutorialSidebar',
           position: 'left',
-          label: 'Tutorial',
+          label: 'Getting Started',
         },
         {
-          href: 'https://github.com/facebook/docusaurus',
+          href: 'https://github.com/isontheline/dRAGon',
           label: 'GitHub',
           position: 'right',
         },
@@ -60,25 +60,17 @@ const config: Config = {
           title: 'Docs',
           items: [
             {
-              label: 'Tutorial',
-              to: '/docs/intro',
+              label: 'Getting Started',
+              to: '/docs/getting-started',
             },
           ],
         },
         {
           title: 'Community',
           items: [
             {
-              label: 'Stack Overflow',
-              href: 'https://stackoverflow.com/questions/tagged/docusaurus',
-            },
-            {
-              label: 'Discord',
-              href: 'https://discordapp.com/invite/docusaurus',
-            },
-            {
-              label: 'Twitter',
-              href: 'https://twitter.com/docusaurus',
+              label: 'Discussions',
+              href: 'https://github.com/isontheLine/dRAGon/discussions',
             },
           ],
         },
@@ -87,7 +79,7 @@ const config: Config = {
           items: [
             {
               label: 'GitHub',
-              href: 'https://github.com/facebook/docusaurus',
+              href: 'https://github.com/isontheline/dRAGon',
             },
           ],
         },

docs/src/components/HomepageFeatures/index.tsx

@@ -4,38 +4,34 @@ import styles from './styles.module.css';
 
 type FeatureItem = {
   title: string;
-  Svg: React.ComponentType<React.ComponentProps<'svg'>>;
   description: JSX.Element;
 };
 
 const FeatureList: FeatureItem[] = [
   {
     title: 'Easy to Use',
-    Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        dRAGon was designed from the ground up to be easily installed and
+        used to get your RAG pipeline up and running quickly.
       </>
     ),
   },
   {
     title: 'Focus on What Matters',
-    Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
     description: (
       <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
+        dRAGon lets you focus on your docs, and we&apos;ll do the chores. Go
+        ahead and import your docs into the pipeline and let dRAGon do the rest.
       </>
     ),
   },
   {
-    title: 'Powered by React',
-    Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
+    title: 'Powered by Spring Boot and Vue.js',
     description: (
       <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
+        dRAGon is built on top of Spring Boot and Vue.js, two of the most popular
+        open-source frameworks for building strong backends and frontends.
       </>
     ),
   },
@@ -45,7 +41,7 @@ function Feature({title, Svg, description}: FeatureItem) {
   return (
     <div className={clsx('col col--4')}>
       <div className="text--center">
-        <Svg className={styles.featureSvg} role="img" />
+        Image here
       </div>
       <div className="text--center padding-horiz--md">
         <Heading as="h3">{title}</Heading>

docs/src/pages/index.tsx

@@ -19,8 +19,8 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/intro">
-            Docusaurus Tutorial - 5min ⏱️
+            to="/docs/getting-started">
+            dRAGon Getting Started - 5min ⏱️
           </Link>
         </div>
       </div>

frontend/index.html

@@ -3,7 +3,7 @@
 
 <head>
       <meta charset="UTF-8">
-      <link rel="icon" href="/favicon.ico">
+      <link rel="icon" href="/favicon.ico" />
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <title>dRAGon</title>
       <link id="theme-css" rel="stylesheet" type="text/css" href="/themes/aura-light-purple/theme.css" />