-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #971 from shelar1423/main
FIX: improved documentation
- Loading branch information
Showing
19 changed files
with
160 additions
and
144 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 17 additions & 2 deletions
19
docs/pages/Guides/Customising-prompts.md → docs/pages/Guides/Customising-prompts.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
|
||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.