From 12809312f0078ffc6974b0a5eb42732588c1031f Mon Sep 17 00:00:00 2001 From: Stan Girard Date: Mon, 3 Jul 2023 12:06:21 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20actions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit added --- .github/workflows/vercel-docs.yml | 23 +++++++++++++++++++++++ docs/docs/roadmap.md | 12 ++++++------ 2 files changed, 29 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/vercel-docs.yml diff --git a/.github/workflows/vercel-docs.yml b/.github/workflows/vercel-docs.yml new file mode 100644 index 000000000000..7763d36954a3 --- /dev/null +++ b/.github/workflows/vercel-docs.yml @@ -0,0 +1,23 @@ +name: Deploy Docs Deployment +env: + VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }} + VERCEL_PROJECT_ID: ${{ secrets.VERCEL_DOC_PROJECT_ID }} +on: + push: + branches: [ "main" ] + paths: + - 'docs/**' +jobs: + Deploy-Preview: + environment: production + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Install Vercel CLI + run: npm install --global vercel@latest + - name: Pull Vercel Environment Information + run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }} + - name: Build Project Artifacts + run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }} + - name: Deploy Project Artifacts to Vercel + run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }} \ No newline at end of file diff --git a/docs/docs/roadmap.md b/docs/docs/roadmap.md index 6e3aebcd5f08..38473a321312 100644 --- a/docs/docs/roadmap.md +++ b/docs/docs/roadmap.md @@ -21,22 +21,22 @@ Quivr is a platform for building second brains and personnal assistants. It is a - [X] Multiple chats - [X] Use own keys - [ ] **v0.2** - Time to share - - [ ] Improved Documentation + - [X] Improved Documentation - [ ] Add a tutorial - [ ] Add a FAQ - [X] Create a website - https://brain.quivr.app - - [ ] Create public & private brains + - [X] Create public & private brains - [ ] Allow users to share/subcribe brains - [ ] Improved UX/UI - [ ] Stream response - - [ ] Better error handling - - [ ] Mobile friendly + - [X] Better error handling + - [X] Mobile friendly - [ ] Chat with one or more files - - [ ] Better API Interface + - [X] Better API Interface - [ ] Refactor backend & frontend for better development experience - [ ] **v0.3** - Make it smarter & private - [ ] Private Brains - - [ ] Use PrivateGPT as LLM and Embedding + - [X] Use PrivateGPT as LLM and Embedding - [ ] Better Storage - [ ] Use a vectorstore for storing embeddings - [ ] Add metadata