quivr/docs
2024-05-10 12:28:06 +02:00
..
_snippets Update website URL in commercial.mdx 2024-05-06 10:20:24 +02:00
agents feat(docs): Add new brain files and update navigation (#2467) 2024-04-22 09:39:24 -07:00
brains docs(gpt4): Update GPT-4 Documentation (#2573) 2024-05-10 01:49:45 -07:00
configuring Update Brave Search URL in documentation 2024-05-10 12:28:06 +02:00
deployment Add caret-up icon to Vercel deployment documentation 2024-04-30 12:34:49 +02:00
developers feat(docs): update to new (#2465) 2024-04-22 08:34:11 -07:00
features fix(docs): update doc (#2470) 2024-04-23 00:40:29 +02:00
images [ImgBot] Optimize images (#2568) 2024-05-09 07:16:31 -07:00
video docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
.gitignore feat(docs): added 2023-06-11 15:37:28 +02:00
contact-us.mdx feat(docs): update to new (#2465) 2024-04-22 08:34:11 -07:00
favicon.ico docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
favicon.svg docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
install.mdx Update install.mdx (#2552) 2024-05-07 08:41:05 +02:00
intro.mdx docs: Update brain documentation and images (#2475) 2024-04-23 02:21:51 -07:00
mint.json feat(brave-search): Update GPT4Brain tools and add WebSearchTool (#2576) 2024-05-10 03:22:15 -07:00
README.md feat(docs): added 2023-06-11 15:37:28 +02:00
roadmap.mdx feat(docs): added homepage (#1919) 2023-12-25 09:02:49 +01:00
slackbot.mdx feat(docs): update to new (#2465) 2024-04-22 08:34:11 -07:00
tech-design.mdx fix(docs): update doc (#2470) 2024-04-23 00:40:29 +02:00

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.