Merge pull request arc53#971 from shelar1423/main

FIX: improved documentation

docs/pages/API/_meta.json

@@ -0,0 +1,10 @@
+{
+  "API-docs": {
+    "title": "🗂️️ API-docs",
+    "href": "/API/API-docs"
+  },
+  "api-key-guide": {
+    "title": "🔐 API Keys guide",
+    "href": "/API/api-key-guide"
+  }
+}

docs/pages/Deploying/Quickstart.md

@@ -110,19 +110,3 @@ Option 2: Using Git Bash or Command Prompt (CMD):
 6. To stop the setup, just press **Ctrl + C** in the Git Bash or Command Prompt terminal.
 
 These steps should help you set up and run the project on Windows using either WSL or Git Bash/Command Prompt. Make sure you have Docker installed and properly configured on your Windows system for this to work.
-
-
-### Chrome Extension
-
-#### Installing the Chrome extension:
-To enhance your DocsGPT experience, you can install the DocsGPT Chrome extension. Here's how:
-
-1. In the DocsGPT GitHub repository, click on the **Code** button and select **Download ZIP**.
-2. Unzip the downloaded file to a location you can easily access.
-3. Open the Google Chrome browser and click on the three dots menu (upper right corner).
-4. Select **More Tools** and then **Extensions**.
-5. Turn on the **Developer mode** switch in the top right corner of the **Extensions page**.
-6. Click on the **Load unpacked** button.
-7. Select the **Chrome** folder where the DocsGPT files have been unzipped (docsgpt-main > extensions > chrome).
-8. The extension should now be added to Google Chrome and can be managed on the Extensions page.
-9. To disable or remove the extension, simply turn off the toggle switch on the extension card or click the **Remove** button.

docs/pages/Deploying/_meta.json

@@ -12,7 +12,7 @@
     "href": "/Deploying/Railway-Deploying"
   },
   "Kubernetes-Deploying": {
-    "title": "🚀Deploying on Kubernetes",
+    "title": "☸️Deploying on Kubernetes",
     "href": "/Deploying/Kubernetes-Deploying"
   }
-}
+}

docs/pages/Extensions/Chrome-extension.mdx

@@ -0,0 +1,34 @@
+
+import {Steps} from 'nextra/components'
+import { Callout } from 'nextra/components'
+
+
+## Chrome  Extension Setup Guide
+
+To enhance your DocsGPT experience, you can install the DocsGPT Chrome extension. Here's how:
+<Steps >
+### Step 1
+
+
+
+In the DocsGPT GitHub repository, click on the **Code** button and select **Download ZIP**.
+### Step 2
+Unzip the downloaded file to a location you can easily access.
+### Step 3
+Open the Google Chrome browser and click on the three dots menu (upper right corner).
+### Step 4
+Select **More Tools** and then **Extensions**.
+### Step 5
+Turn on the **Developer mode** switch in the top right corner of the **Extensions page**.
+### Step 6
+Click on the **Load unpacked** button.
+### Step 7
+7. Select the **Chrome** folder where the DocsGPT files have been unzipped (docsgpt-main > extensions > chrome).
+### Step 8
+The extension should now be added to Google Chrome and can be managed on the Extensions page.
+### Step 9
+ To disable or remove the extension, simply turn off the toggle switch on the extension card or click the **Remove** button.
+</Steps>
+
+
+

docs/pages/Extensions/_meta.json

@@ -7,8 +7,8 @@
     "title": "🏗️ Widget setup",
     "href": "/Extensions/react-widget"
   },
-  "api-key-guide": {
-    "title": "🔐 API Keys guide",
-    "href": "/Extensions/api-key-guide"
+  "Chrome-extension": {
+    "title": "🌐 Chrome Extension",
+    "href": "/Extensions/Chrome-extension"
   }
 }

docs/pages/Guides/Customising-prompts.md → docs/pages/Guides/Customising-prompts.mdx

@@ -1,10 +1,25 @@
+import Image from 'next/image'
+
 # Customizing the Main Prompt
 
 Customizing the main prompt for DocsGPT gives you the ability to tailor the AI's responses to your specific requirements. By modifying the prompt text, you can achieve more accurate and relevant answers. Here's how you can do it:
 
-1. Navigate to `/application/prompts/combine_prompt.txt`.
+1. Navigate to `SideBar -> Settings`.
+
+
+
+
+2.In Settings select the `Active Prompt` now you will be able to see various prompts style.x
+
+
+
+
+3.Click on the `edit icon`  on the prompt of your choice and you will be able to see the current prompt for it,you can now customise  the prompt as per your choice.
+
+### Video Demo
+<Image src="/prompts.gif" alt="prompts" width={800} height={500} />
+
 
-2. Open the `combine_prompt.txt` file and modify the prompt text to suit your needs. You can experiment with different phrasings and structures to observe how the model responds. The main prompt serves as guidance to the AI model on how to generate responses.
 
 ## Example Prompt Modification
 

docs/pages/Guides/How-to-train-on-other-documentation.mdx

@@ -0,0 +1,44 @@
+
+import { Callout } from 'nextra/components'
+import Image from 'next/image'
+import { Steps } from 'nextra/components'
+
+## How to train on other documentation
+
+Training on other documentation sources can greatly enhance the versatility and depth of DocsGPT's knowledge. By incorporating diverse materials, you can broaden the AI's understanding and improve its ability to generate insightful responses across a range of topics. Here's a step-by-step guide on how to effectively train DocsGPT on additional documentation sources:
+
+**Get your document ready**:
+
+Make sure you have the document on which you want to train on  ready with you on the device which you are using .You can also use links to the documentation to train on.
+
+<Callout type="warning" emoji="⚠️">
+ Note: The document should be either of the given file formats .pdf, .txt, .rst, .docx, .md, .zip and  limited to 25mb.You can also train using the link of the documentation.
+
+</Callout>
+
+### Video Demo
+
+<Image src="/docs.gif" alt="prompts" width={800} height={500} />
+
+
+
+<Steps>
+### Step1
+Navigate to the sidebar where you will find `Source Docs` option,here you will find 3 options built in which are default,Web Search and None.
+
+
+### Step 2
+Click on the `Upload icon` just beside the source docs options,now borwse and upload the document which you want to train on or select the `remote` option if you have to insert the link of the documentation.
+
+
+### Step 3
+Now you will be able to see the name of the file uploaded under the Uploaded Files ,now click on `Train`,once you click on train it might take some time to train on the document. You will be able to see the `Training progress` and once the training is completed you can click the `finish` button and there you go your docuemnt is uploaded.
+
+
+### Step 4
+Go to `New chat`  and from the side bar select the document  you uploaded  under the `Source Docs` and go ahead with your chat, now you can ask qestions regarding the document you uploaded and you will get the effective answer based on it.
+
+</Steps>
+
+
+

docs/pages/Guides/How-to-use-different-LLM.mdx

@@ -0,0 +1,41 @@
+
+import { Callout } from 'nextra/components'
+import Image from 'next/image'
+import { Steps } from 'nextra/components'
+
+# Setting Up Local Language Models for Your App
+
+Setting up local language models for your app can significantly enhance its capabilities, enabling it to understand and generate text in multiple languages without relying on external APIs. By integrating local language models, you can improve privacy, reduce latency, and ensure continuous functionality even in offline environments. Here's a comprehensive guide on how to set up local language models for your application:
+
+## Steps:
+### For cloud version LLM change:
+<Steps >
+### Step 1
+Visit the chat screen and you will be to see the default LLM selected.
+### Step 2
+Click on it and you will get a drop down of various LLM's available to choose.
+### Step 3
+Choose the LLM of your choice.
+
+</Steps>
+
+
+
+
+### Video Demo
+<Image src="/llms.gif" alt="prompts" width={800} height={500} />
+
+### For Open source llm change:
+<Steps >
+### Step 1
+For open source you  have to edit .env file with LLM_NAME with their desired LLM name.
+### Step 2
+All the supported LLM providers are here application/llm and you  can check what env variable are needed for each
+List of latest supported LLMs are https://github.com/arc53/DocsGPT/blob/main/application/llm/llm_creator.py
+### Step 3
+Visit application/llm and select the file of your selected llm and there you will find the speicifc requirements needed to be filled in order to use it,i.e API key of that llm.
+</Steps>
+
+
+
+

docs/pages/Guides/_meta.json

@@ -1,14 +1,14 @@
 {
   "Customising-prompts": {
-    "title": "🏗️️ Customising Prompts",
+    "title": "️💻 Customising Prompts",
     "href": "/Guides/Customising-prompts"
   },
   "How-to-train-on-other-documentation": {
     "title": "📥 Training on docs",
     "href": "/Guides/How-to-train-on-other-documentation"
   },
   "How-to-use-different-LLM": {
-    "title": "⚙️️ How to use different LLM's",
+    "title": "️🤖 How to use different LLM's",
     "href": "/Guides/How-to-use-different-LLM"
   },
   "My-AI-answers-questions-using-external-knowledge": {

docs/pages/index.mdx

@@ -2,14 +2,16 @@
 title: 'Home'
 ---
 import { Cards, Card } from 'nextra/components'
+import Image from 'next/image'
 import deployingGuides from './Deploying/_meta.json';
-import developingGuides from './Developing/_meta.json';
+import developingGuides from './API/_meta.json';
 import extensionGuides from './Extensions/_meta.json';
 import mainGuides from './Guides/_meta.json';
 
 
 
 
+
 export const allGuides = {
   ...deployingGuides,
   ...developingGuides,
@@ -21,7 +23,10 @@ export const allGuides = {
 
 DocsGPT 🦖 is an innovative open-source tool designed to simplify the retrieval of information from project documentation using advanced GPT models 🤖. Eliminate lengthy manual searches 🔍 and enhance your documentation experience with DocsGPT, and consider contributing to its AI-powered future 🚀.
 
-![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif)
+
+
+<Image src="/homevideo.gif" alt="homedemo" width={800} height={500}/>
+
 
 Try it yourself: [https://docsgpt.arc53.com/](https://docsgpt.arc53.com/)