feat: 🎸 doc

added new page
QuivrHQ · Dec 25, 2023 · 736778d · 736778d
1 parent 030b353
commit 736778d
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 55 deletions.
diff --git a/docs/userGuide/api-based-brains.mdx → docs/getting-started/api-based-brains.mdx b/docs/userGuide/api-based-brains.mdx → docs/getting-started/api-based-brains.mdx
diff --git a/docs/userGuide/brain.mdx → docs/getting-started/brain.mdx b/docs/userGuide/brain.mdx → docs/getting-started/brain.mdx
diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx
@@ -0,0 +1,52 @@
+---
+title: "Understand"
+---
+
+![](/images/homepage.png)
+
+## How can you leverage Quivr ? 🚀
+
+You can use Quivr to:
+
+<AccordionGroup>
+<Accordion title="Search in files" icon="searchengin">
+  Quivr allows you to easily ask questions about your files
+</Accordion>
+<Accordion title="Cross-search" icon="shuffle">
+  Tired of Cross referencing your information between files ?
+</Accordion>
+<Accordion title="Store your knowledge" icon="database">
+  Store all your knowledge in one place
+</Accordion>
+<Accordion title="Share your knowledge" icon="share">
+  Share your knowledge with your team by leveraging the collaboration features
+</Accordion>
+</AccordionGroup>
+
+
+## Features 🤗
+
+### Public & Private Brains
+
+You can create **public** and **private** brains.
+
+<AccordionGroup>
+  <Accordion title="Public" icon="globe">
+  A public brain is a brain that is searchable by everyone on Quivr. You can make a brain public by clicking on the **public** button on the brain page.
+  </Accordion>
+  <Accordion title="Private" icon="lock">
+  A private brain is a brain that is only searchable by you. You can make a brain private by clicking on the **private** button on the brain page.
+  </Accordion>
+</AccordionGroup>
+
+
+You can share your brains with a set of people by using their emails. This means that you can **collaborate** with your team on a brain without making it public.
+
+### Ask Questions
+
+You can **ask questions** to Quivr. Quivr will **answer** your questions by leveraging the **knowledge** that you uploaded to Quivr.
+
+### Custom Personality 
+
+You can **customize** the personality of Quivr by changing the **prompt** of your brain. You could tell your brain to always answer with a **funny** or **serious** tone or act like a **robot** or a **human**.
+
diff --git a/docs/intro.mdx b/docs/intro.mdx
@@ -1,13 +1,30 @@
 ---
-title: 🚀 Welcome to Quivr
+title: Welcome
 description: Quivr is your Second Brain that can acts as your personal assistant.
 ---
 
+Welcome to the documentation of Quivr! This is the place where you’ll find help, guidance and support for collaborative software development. Whether you’re involved in an open-source community or a large software team, these resources should get you up and running quickly!
+
+
 [Quivr](https://quivr.app) is your **Second Brain** that can acts as your **personal assistant**. 
 
-It can:
-- **Answer questions** to the **files** that you uploaded
-- **Interact** with the **applications** that you connected to Quivr
+
+<CardGroup cols={3}>
+  <Card
+    title="Understand Quivr"
+    icon="forward"
+    href="/getting-started/quickstart"
+  >
+    Get your own assistant in less than 5 seconds
+  </Card>
+  <Card
+    title="Video Installation"
+    icon="youtube"
+    href="https://dub.sh/quivr-demo"
+  >
+    We've cooked some video materials to get you in-depth assistance for your setup.
+  </Card>
+</CardGroup>
 
 <Tip>
 **Our goal** is to make Quivr the **best open-source personal assistant** that is powered by your knowledge and your applications 🔥
@@ -44,50 +61,3 @@ It takes less than **5 seconds** to get started with Quivr. You can even use you
 
 
 
-
-## How can you leverage Quivr ? 🚀
-
-You can use Quivr to:
-
-<AccordionGroup>
-<Accordion title="Search in files" icon="searchengin">
-  Quivr allows you to easily ask questions about your files
-</Accordion>
-<Accordion title="Cross-search" icon="shuffle">
-  Tired of Cross referencing your information between files ?
-</Accordion>
-<Accordion title="Store your knowledge" icon="database">
-  Store all your knowledge in one place
-</Accordion>
-<Accordion title="Share your knowledge" icon="share">
-  Share your knowledge with your team by leveraging the collaboration features
-</Accordion>
-</AccordionGroup>
-
-
-## Features 🤗
-
-### Public & Private Brains
-
-You can create **public** and **private** brains.
-
-<AccordionGroup>
-  <Accordion title="Public" icon="globe">
-  A public brain is a brain that is searchable by everyone on Quivr. You can make a brain public by clicking on the **public** button on the brain page.
-  </Accordion>
-  <Accordion title="Private" icon="lock">
-  A private brain is a brain that is only searchable by you. You can make a brain private by clicking on the **private** button on the brain page.
-  </Accordion>
-</AccordionGroup>
-
-
-You can share your brains with a set of people by using their emails. This means that you can **collaborate** with your team on a brain without making it public.
-
-### Ask Questions
-
-You can **ask questions** to Quivr. Quivr will **answer** your questions by leveraging the **knowledge** that you uploaded to Quivr.
-
-### Custom Personality 
-
-You can **customize** the personality of Quivr by changing the **prompt** of your brain. You could tell your brain to always answer with a **funny** or **serious** tone or act like a **robot** or a **human**.
-
diff --git a/docs/mint.json b/docs/mint.json
@@ -45,16 +45,17 @@
   ],
   "navigation": [
     {
-      "group": "Getting Started",
+      "group": "Home",
       "pages": [
-        "intro"
+        "intro",
+        "getting-started/quickstart"
       ]
     },
     {
       "group": "Power-user",
       "pages": [
-        "userGuide/brain",
-        "userGuide/api-based-brains"
+        "getting-started/brain",
+        "getting-started/api-based-brains"
       ]
     },
     {