Skip to content

Commit

Permalink
feat: Add new documentation files (QuivrHQ#3351)
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 Oct 9, 2024
1 parent 7b81ae5 commit d6c7735
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 5 deletions.
1 change: 1 addition & 0 deletions backend/docs/docs/examples/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Examples
1 change: 1 addition & 0 deletions backend/docs/docs/vectorstores/faiss.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Faiss
2 changes: 2 additions & 0 deletions backend/docs/docs/vectorstores/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Vector Stores

1 change: 1 addition & 0 deletions backend/docs/docs/vectorstores/pgvector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# PGVector
1 change: 1 addition & 0 deletions backend/docs/docs/workflows/examples/chat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Chat
1 change: 1 addition & 0 deletions backend/docs/docs/workflows/examples/rag_with_internet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# RAG with Internet
1 change: 1 addition & 0 deletions backend/docs/docs/workflows/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuration
20 changes: 15 additions & 5 deletions backend/docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,20 @@ nav:
- Home:
- index.md
- installation.md
- Features:
- Parsers:
- parsers/index.md
- parsers/megaparse.md
- parsers/simple.md
- Parsers:
- parsers/index.md
- parsers/megaparse.md
- parsers/simple.md
- Vector Stores:
- vectorstores/index.md
- vectorstores/faiss.md
- vectorstores/pgvector.md
- Workflows:
- workflows/index.md
- Examples:
- workflows/examples/chat.md
- workflows/examples/rag_with_internet.md
- Examples:
- examples/index.md
- Enterprise: https://docs.quivr.app/

0 comments on commit d6c7735

Please sign in to comment.