diff --git a/docs/developers/contribution/architecture.mdx b/docs/developers/contribution/architecture.mdx index a95a2d176323..65f792101bb2 100644 --- a/docs/developers/contribution/architecture.mdx +++ b/docs/developers/contribution/architecture.mdx @@ -36,7 +36,7 @@ You can find more information in the [Authentication](/docs/Developers/useQuivr/
- Quivr architecture + Quivr architecture
### Load Balancer diff --git a/docs/developers/selfHosting/run_fully_local.mdx b/docs/developers/selfHosting/run_fully_local.mdx index b79bea913f1a..8b95b96758a7 100644 --- a/docs/developers/selfHosting/run_fully_local.mdx +++ b/docs/developers/selfHosting/run_fully_local.mdx @@ -1,20 +1,6 @@ --- -sidebar_position: 2 title: Run Quivr locally with Ollama --- - -# Using Quivr fully locally with Ollama - -## Headers - -The following is a guide to set up everything for using Quivr locally: - -##### Table of Contents - -- [Database](#database) -- [Embeddings](#embeddings) -- [LLM for inference](#llm) - The guide was put together in collaboration with members of the Quivr Discord, **Using Quivr fully locally** thread. That is a good place to discuss it. https://discord.com/invite/HUpRgp2HG8 ## Ollama diff --git a/docs/developers/useQuivr/chat.mdx b/docs/developers/useQuivr/chat.mdx index 5a92d44e6d33..a5e8338955db 100644 --- a/docs/developers/useQuivr/chat.mdx +++ b/docs/developers/useQuivr/chat.mdx @@ -42,7 +42,7 @@ Users can create multiple chat sessions, each with its own set of chat messages. - Description: This endpoint allows adding a new question to a chat. It generates an answer for the question using different models based on the provided model type. Models like gpt-4-0613 and gpt-3.5-turbo-0613 use a custom OpenAI function-based answer generator. - ![Function based answer generator](/img/answer_schema.png) + ![Function based answer generator](/images/answer_schema.png) 6. **Get the chat history:** - HTTP method: GET diff --git a/docs/images/answer_schema.png b/docs/images/answer_schema.png new file mode 100644 index 000000000000..7fe109292879 Binary files /dev/null and b/docs/images/answer_schema.png differ diff --git a/docs/images/api-brain-params.png b/docs/images/api-brain-params.png new file mode 100644 index 000000000000..7a81b1ab4d7e Binary files /dev/null and b/docs/images/api-brain-params.png differ diff --git a/docs/images/api-brain-search-params.png b/docs/images/api-brain-search-params.png new file mode 100644 index 000000000000..31c090509cfb Binary files /dev/null and b/docs/images/api-brain-search-params.png differ diff --git a/docs/images/api-brain-secrets.png b/docs/images/api-brain-secrets.png new file mode 100644 index 000000000000..251854a15f5c Binary files /dev/null and b/docs/images/api-brain-secrets.png differ diff --git a/docs/images/architectural-high-level.png b/docs/images/architectural-high-level.png new file mode 100644 index 000000000000..56107ddf1ef6 Binary files /dev/null and b/docs/images/architectural-high-level.png differ diff --git a/docs/images/docusaurus-social-card.jpg b/docs/images/docusaurus-social-card.jpg new file mode 100644 index 000000000000..ffcb448210e1 Binary files /dev/null and b/docs/images/docusaurus-social-card.jpg differ diff --git a/docs/images/docusaurus.png b/docs/images/docusaurus.png new file mode 100644 index 000000000000..f458149e3c8f Binary files /dev/null and b/docs/images/docusaurus.png differ diff --git a/docs/images/homepage.png b/docs/images/homepage.png new file mode 100644 index 000000000000..8b2d41bcf829 Binary files /dev/null and b/docs/images/homepage.png differ diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 000000000000..b433ea188d16 Binary files /dev/null and b/docs/images/logo.png differ diff --git a/docs/images/logo.svg b/docs/images/logo.svg new file mode 100644 index 000000000000..9db6d0d066e3 --- /dev/null +++ b/docs/images/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/north-star-quivr.png b/docs/images/north-star-quivr.png new file mode 100644 index 000000000000..478e2e8c46de Binary files /dev/null and b/docs/images/north-star-quivr.png differ diff --git a/docs/images/quivr-logo.ico b/docs/images/quivr-logo.ico new file mode 100644 index 000000000000..521bb4b80f0d Binary files /dev/null and b/docs/images/quivr-logo.ico differ diff --git a/docs/images/undraw_docusaurus_mountain.svg b/docs/images/undraw_docusaurus_mountain.svg new file mode 100644 index 000000000000..af961c49a888 --- /dev/null +++ b/docs/images/undraw_docusaurus_mountain.svg @@ -0,0 +1,171 @@ + + Easy to Use + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/undraw_docusaurus_react.svg b/docs/images/undraw_docusaurus_react.svg new file mode 100644 index 000000000000..94b5cf08f88f --- /dev/null +++ b/docs/images/undraw_docusaurus_react.svg @@ -0,0 +1,170 @@ + + Powered by React + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/undraw_docusaurus_tree.svg b/docs/images/undraw_docusaurus_tree.svg new file mode 100644 index 000000000000..d9161d33920c --- /dev/null +++ b/docs/images/undraw_docusaurus_tree.svg @@ -0,0 +1,40 @@ + + Focus on What Matters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/intro.mdx b/docs/intro.mdx index dd58027ff5dc..2845ce4757df 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -3,23 +3,19 @@ title: 🚀 Welcome to Quivr description: Quivr is your Second Brain that can acts as your personal assistant. --- - -## Welcome to Quivr 🧠 - [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 (Soon 🚀) +- **Interact** with the **applications** that you connected to Quivr -:::info -**Our goal **is to make Quivr the **best open-source personal assistant** that is powered by your knowledge and your applications 🔥 + +**Our goal** is to make Quivr the **best open-source personal assistant** that is powered by your knowledge and your applications 🔥 It will remain open-source -::: + ## What does it do ? -> A video equals a thousand words
- ## How to get started ? 👀 -:::tip + It takes less than **5 seconds** to get started with Quivr. You can even use your Google account to sign up. -::: + + + + + Go to [Quivr](https://quivr.app) and create an account. + + + Upload a file to Quivr. + + + Ask questions to Quivr about your file. + + + -- Create an account on [Quivr](https://quivr.app) -- Upload your files -- Ask questions to Quivr - -
- Quivr home page -
## How can you leverage Quivr ? 🚀 You can use Quivr to: -- **Search** information in your files -- **Cross-search** information from your files -- **Store** all your knowledge in one place -- **Share** your knowledge with your team by leveraging the **collaboration** features + + + + Quivr allows you to easily ask questions about your files + + + Tired of Cross referencing your information between files ? + + + Store all your knowledge in one place + + + Share your knowledge with your team by leveraging the collaboration features + + + ## Features 🤗 @@ -61,6 +74,16 @@ You can create **public** and **private** brains. - **Public** brains are **searchable** by everyone on Quivr - **Private** brains are **only searchable** by you + + + 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. + + + 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. + + + + 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 diff --git a/docs/mint.json b/docs/mint.json index 34d6213c2af4..fe3c46708f3f 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -3,12 +3,13 @@ "name": "Quivr", "favicon": "/favicon.svg", "colors": { - "primary": "#0D9373", - "light": "#07C983", - "dark": "#0D9373", + "primary": "#6142D4", + "light": "#F6F4FF", + "dark": "#13ABBA", "anchors": { - "from": "#0D9373", - "to": "#07C983" + "from": "#6142D4", + "to": "#F6F4FF" + } }, "topbarLinks": [ @@ -46,15 +47,14 @@ ], "navigation": [ { - "group": "Get Started", + "group": "Getting Started", "pages": [ "intro" ] }, { - "group": "How to use Quivr", + "group": "Power-user", "pages": [ - "userGuide/intro", "userGuide/what-is-a-brain", "userGuide/api-based-brains" ] @@ -110,7 +110,13 @@ "footerSocials": { "twitter": "https://twitter.com/quivr_brain", "github": "https://github.com/stangirard/quivr", - "linkedin": "https://www.linkedin.com/company/getquivr" + "linkedin": "https://www.linkedin.com/company/getquivr", + "discord": "https://discord.gg/HUpRgp2HG8" }, - "openapi": "https://api.quivr.app/openapi.json" + "openapi": "https://api.quivr.app/openapi.json", + "feedback": { + "thumbsRating": true, + "raiseIssue": true, + "suggestEdit": true + } } \ No newline at end of file diff --git a/docs/roadmap.mdx b/docs/roadmap.mdx index 4f8405c78f2b..81bbb20d5c29 100644 --- a/docs/roadmap.mdx +++ b/docs/roadmap.mdx @@ -6,4 +6,4 @@ title: 🎯 Roadmap # Roadmap A personal assistant that can help you with your daily tasks, such as scheduling meetings, taking notes, and answering questions. -![](/img/north-star-quivr.png) +![](/images/north-star-quivr.png) diff --git a/docs/userGuide/api-based-brains.mdx b/docs/userGuide/api-based-brains.mdx index 308d8b73f708..d16ee2c75cf3 100644 --- a/docs/userGuide/api-based-brains.mdx +++ b/docs/userGuide/api-based-brains.mdx @@ -1,11 +1,11 @@ --- -sidebar_position: 3 -title: API Based Brains +title: API Brains --- -:::info + A few brains were harmed in making API based brains 🤯 -::: + + Quivr allows to create an API based brain. These brains can automatically call APIs to retrieve information and use it to answer questions. While an API needs to be called but all required information is not available in the conversation, Quivr will ask user to provide them before calling the API. @@ -29,7 +29,8 @@ The method to use when calling the API. Allowed values are `GET`, `POST`, `PUT`, These values are passed to the API as the request body. Values are inferred from the conversation. If all required info are not furnished, the call will ask user to provide them before calling the API. -API Brain Params +API Brain Params + ## Search Params @@ -37,10 +38,12 @@ These values are passed to the API as search params. Values are inferred from th Example of search param: `https://api.example.com?param1=value1¶m2=value2` -API Brain Search Params +API Brain Search Params + ## Secrets Secrets are safely stored in a vault storage database and are not exposed to the LLM. They are passed to the API as headers. -API Brain Secrets +API Brain Secrets + diff --git a/docs/userGuide/what-is-a-brain.mdx b/docs/userGuide/what-is-a-brain.mdx index 622f4e259703..d679aa6cf642 100644 --- a/docs/userGuide/what-is-a-brain.mdx +++ b/docs/userGuide/what-is-a-brain.mdx @@ -3,9 +3,10 @@ sidebar_position: 2 title: Concept of Brain --- -:::info + A few brains were harmed in the making of this documentation 🤯😏 -::: + + # Introduction to Brains