Skip to content

Commit

Permalink
feat(docs): added homepage (#1919)
Browse files Browse the repository at this point in the history
# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):
  • Loading branch information
StanGirard authored Dec 25, 2023
1 parent 33eec50 commit 15d43c4
Show file tree
Hide file tree
Showing 23 changed files with 459 additions and 58 deletions.
2 changes: 1 addition & 1 deletion docs/developers/contribution/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can find more information in the [Authentication](/docs/Developers/useQuivr/


<div style={{ textAlign: 'center' }}>
<img src="/img/architectural-high-level.png" alt="Quivr architecture" style={{ width: '60%' }} />
<img src="/images/architectural-high-level.png" alt="Quivr architecture" style={{ width: '60%' }} />
</div>

### Load Balancer
Expand Down
14 changes: 0 additions & 14 deletions docs/developers/selfHosting/run_fully_local.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/useQuivr/chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file added docs/images/answer_schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/api-brain-params.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/api-brain-search-params.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/api-brain-secrets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/architectural-high-level.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/docusaurus-social-card.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/docusaurus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/north-star-quivr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quivr-logo.ico
Binary file not shown.
Loading

0 comments on commit 15d43c4

Please sign in to comment.