feat(docs): added env file

docs/docs/Developers/connectors/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "📲 Connect Quivr to ...",
+  "label": "Chat to Quivr with ...",
   "position": 3,
   "link": {
     "type": "generated-index",

docs/docs/Developers/contribution/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "⌨️ Contribute to Quivr",
+  "label": "Explanation",
   "position": 1,
   "link": {
     "type": "generated-index",

docs/docs/Developers/contribution/architecture.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-title: 🏛️ Architecture
+title: Architecture
 ---
 
 Quivr is using FastAPI to provide a RESTful API for the backend. The API is currently in beta and is subject to change. The API is available at [https://api.quivr.app](https://api.quivr.app).

docs/docs/Developers/contribution/chains/_category_.json

@@ -1,9 +1,8 @@
 {
-  "label": "⛓️ Chains",
+  "label": "Chains",
   "position": 5,
   "link": {
     "type": "generated-index",
     "description": "What are chains?"
   }
-}
-
+}

docs/docs/Developers/contribution/env.md

@@ -0,0 +1,74 @@
+---
+title: Environment File
+sidebar_position: 8
+---
+
+You have two environment files in the root of the project:
+
+One in `backend/.env` and the other in `frontend/.env`.
+
+### Backend Environment File
+
+The backend environment file is used to configure the backend server. It contains the following variables:
+
+- `SUPABASE_URL`: The connection string to the project's Supabase application, which is a suite of open source tools that provide functionality similar to Firebase.
+
+- `SUPABASE_SERVICE_KEY`: Used for server-side requests to authenticate with Supabase, providing administrative access to the database and other services.
+
+- `OPENAI_API_KEY`: The key required to authenticate requests to OpenAI's API for accessing their services, such as language models like GPT-3 or GPT-4.
+
+- `JWT_SECRET_KEY`: A secret key for signing and verifying JSON Web Tokens, used in the authentication process to secure the tokens exchanged between client and server.
+
+- `CELERY_BROKER_URL`: The URL of the message broker for Celery (using Redis), which is an asynchronous task queue/job queue based on distributed message passing.
+
+- `RESEND_API_KEY`: The API key for a service referred to as "RESEND," which likely deals with email sending or processing.
+
+- `RESEND_EMAIL_ADDRESS`: The email address used by the "RESEND" service, possibly as the sender's address for onboarding communications.
+
+- `RESEND_CONTACT_SALES_FROM`: The sender's email address for sales-related inquiries sent through the "RESEND" service.
+
+- `RESEND_CONTACT_SALES_TO`: The recipient's email address for sales inquiries using the "RESEND" service.
+
+- `PREMIUM_MAX_BRAIN_NUMBER`: A limit on the number of 'brains' a premium user can have
+
+- `PREMIUM_MAX_BRAIN_SIZE`: The maximum allowed size for a 'brain'
+
+- `PREMIUM_DAILY_CHAT_CREDIT`: The number of daily credits allocated to a premium user, possibly limiting the number of API calls or operations a user can perform each day.
+
+### Frontend Environment File
+
+The frontend environment file is used to configure the frontend application. It contains the following variables:
+
+- `NEXT_PUBLIC_ENV`: Specifies the environment in which the Next.js application is running (e.g., local, development, production).
+
+- `NEXT_PUBLIC_BACKEND_URL`: The URL where the backend of the application is running, used to make server-side requests.
+
+- `NEXT_PUBLIC_FRONTEND_URL`: The URL where the frontend of the application is accessible. The asterisk (*) may indicate that any port can be used when running locally.
+
+- `NEXT_PUBLIC_SUPABASE_URL`: The connection string to the project's Supabase application for the frontend to interact with Supabase services.
+
+- `NEXT_PUBLIC_SUPABASE_ANON_KEY`: The public 'anonymous' key for Supabase that is used in the frontend for services that don't require full user authentication.
+
+- `NEXT_PUBLIC_GROWTHBOOK_CLIENT_KEY`: The client key for GrowthBook, which is a feature flagging and experimentation platform. The variable might be set to a default or placeholder value.
+
+- `NEXT_PUBLIC_GROWTHBOOK_URL`: The URL for the GrowthBook service. This is also set to a default or placeholder value.
+
+- `NEXT_PUBLIC_JUNE_API_KEY`: The API key for accessing June services, which is likely analytics or marketing related, again set to a default or placeholder value.
+
+- `NEXT_PUBLIC_GA_ID`: The tracking ID for Google Analytics, which is used to monitor and track user interactions on the website.
+
+- `NEXT_PUBLIC_E2E_URL`: The URL for end-to-end (E2E) testing, usually pointing to a testing environment.
+
+- `NEXT_PUBLIC_E2E_EMAIL`: An email address used for end-to-end testing purposes.
+
+- `NEXT_PUBLIC_E2E_PASSWORD`: A password used in conjunction with the E2E_EMAIL for testing authentication flows.
+
+- `NEXT_PUBLIC_CMS_URL`: The URL to access the Content Management System (CMS) for the application.
+
+- `NEXT_PUBLIC_STRIPE_PRICING_TABLE_ID`: An identifier for a pricing table in Stripe, which is a payment processing platform.
+
+- `NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY`: The publishable key for Stripe, used to initiate transactions on the frontend.
+
+- `NEXT_PUBLIC_STRIPE_MANAGE_PLAN_URL`: The URL for managing Stripe subscription plans.
+
+- `NEXT_PUBLIC_AUTH_MODES`: The authentication modes supported by the application, such as magic link, password-based authentication, and Google Single Sign-On (SSO).

docs/docs/Developers/contribution/frontend/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "💻 Frontend",
+  "label": "Frontend",
   "position": 4,
   "link": {
     "type": "generated-index"

docs/docs/Developers/contribution/guidelines.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-title: 🆘 Guidelines
+title: Guidelines
 ---
 
 # Contributing to Quivr
@@ -12,6 +12,7 @@ Thanks for your interest in contributing to Quivr! Here you'll find guidelines f
 ## Table of Contents
 
 - [Contributing to Quivr](#contributing-to-quivr)
+    - [Repo: Quivr Github](#repo-quivr-github)
   - [Table of Contents](#table-of-contents)
   - [Community](#community)
   - [Roadmap and Issues](#roadmap-and-issues)

docs/docs/Developers/contribution/install.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-title: 🧑‍💻 Install Quivr
+title: Install Quivr
 ---
 
 Sure, here's an improved version of your markdown document:

docs/docs/Developers/contribution/test.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 7
-title: 🧪 Testing Strategies
+title: Testing Strategies
 ---
 
 ## Backend

docs/docs/Developers/run_fully_local.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-title: 📍 Run Quivr fully locally
+title: Run Quivr fully locally
 ---
 
 # Using Quivr fully locally

docs/docs/Developers/useQuivr/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "🔗 Use Quivr Backend",
+  "label": "Use Quivr Backend",
   "position": 2,
   "link": {
     "type": "generated-index",

docs/docs/Developers/useQuivr/brain/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "🧠 Brain",
+  "label": "Brain",
   "position": 3,
   "link": {
     "type": "generated-index",

docs/docs/Developers/useQuivr/brain/create_a_brain.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-title: 🆕 Create a brain
+title: Create a brain
 ---
 
 To create a brain, you need to make a POST request to the `/brains/` endpoint. This endpoint requires authentication, and you need to provide the following parameters in the request body:

docs/docs/Developers/useQuivr/brain/retrieve_brain_attributes.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-title: 🧠 Get a Brain
+title: Get a Brain
 ---
 
 To get a brain, you need to make a GET request to the following endpoints.

docs/docs/Developers/useQuivr/brain/set_defaut_brain.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-title: 🫵 Set a Default Brain
+title: Set a Default Brain
 ---
 
 To set a brain as the default for the current user, you need to make a POST request to the following endpoint:

docs/docs/Developers/useQuivr/brain/update_a_brain.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-title: ✍️ Update a Brain
+title: Update a Brain
 ---
 
 To update a brain, you need to make a PUT request to the following endpoint:

docs/docs/Developers/useQuivr/chat.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-title: 🤖 Chat system
+title: Chat system
 ---
 
 **URL**: https://api.quivr.app/chat

docs/docs/Developers/useQuivr/error_handling.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 5
-title: 😩 Error Handling
+title: Error Handling
 ---
 
 **URL**: https://api.quivr.app/chat

docs/docs/Developers/useQuivr/get_your_api_key.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-title: 🔐 Get your API key
+title: Get your API key
 ---
 
 To use the Quivr API, you need to get an API key. You can get one by following these steps:

docs/docs/Developers/useQuivr/getting_started.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-title: ❓ How to use the API
+title: How to use the API
 ---
 
 **URL**: https://api.quivr.app

docs/docs/User_Guide/intro.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-title: 🕺 Getting started
+title: Getting started
 ---
 
 ## How to get started ? 👀

docs/docs/User_Guide/what-is-a-brain.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-title: 🧠 Concept of Brain
+title: Concept of Brain
 ---
 
 :::info