mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-26 12:55:01 +03:00
8c7277e9ec
# Description Added some initial documentation on RAG workflows, including also some nice Excalidraw diagrams 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):
93 lines
2.1 KiB
YAML
93 lines
2.1 KiB
YAML
site_name: Quivr
|
|
extra_css:
|
|
- css/style.css
|
|
|
|
markdown_extensions:
|
|
- attr_list
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- md_in_html
|
|
- toc:
|
|
permalink: "#"
|
|
|
|
theme:
|
|
custom_dir: overrides
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tabs
|
|
- navigation.indexes
|
|
- navigation.top
|
|
- navigation.footer
|
|
- toc.follow
|
|
- content.code.copy
|
|
- search.suggest
|
|
- search.highlight
|
|
name: material
|
|
palette:
|
|
- media: (prefers-color-scheme)
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
- accent: purple
|
|
media: "(prefers-color-scheme: light)"
|
|
primary: white
|
|
scheme: default
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- accent: purple
|
|
media: "(prefers-color-scheme: dark)"
|
|
primary: black
|
|
scheme: slate
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to system preference
|
|
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
default_handler: python
|
|
handlers:
|
|
python:
|
|
docstring_style: google
|
|
options:
|
|
show_source: false
|
|
heading_level: 2
|
|
separate_signature: true
|
|
|
|
nav:
|
|
- Home:
|
|
- index.md
|
|
- quickstart.md
|
|
- Brain:
|
|
- brain/index.md
|
|
- brain/brain.md
|
|
- brain/chat.md
|
|
- Storage:
|
|
- storage/index.md
|
|
- storage/base.md
|
|
- storage/local_storage.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/basic_ingestion.md
|
|
- workflows/examples/basic_rag.md
|
|
- workflows/examples/rag_with_web_search.md
|
|
- Configuration:
|
|
- config/index.md
|
|
- config/config.md
|
|
- config/base_config.md
|
|
- Examples:
|
|
- examples/index.md
|
|
- examples/custom_storage.md
|
|
- Enterprise: https://docs.quivr.app/
|