mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-14 17:03:29 +03:00
751d849b5e
This pull request updates the documentation and images for the default brain in Quivr. It includes instructions on how to get started, customize the brain, and ask questions. Additionally, it adds documentation for the GPT-4 brain and provides steps on how to interact with it. |
||
|---|---|---|
| .. | ||
| _snippets | ||
| agents | ||
| brains | ||
| deployment | ||
| developers | ||
| features | ||
| images | ||
| video | ||
| .gitignore | ||
| configuring.mdx | ||
| contact-us.mdx | ||
| favicon.ico | ||
| favicon.svg | ||
| install.mdx | ||
| intro.mdx | ||
| mint.json | ||
| README.md | ||
| roadmap.mdx | ||
| slackbot.mdx | ||
| tech-design.mdx | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.