From 5f0cccb81e540f980e951458e72818cddf346bad Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 10:37:58 +0530 Subject: [PATCH 01/10] Update Customising-prompts.md --- docs/pages/Guides/Customising-prompts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Guides/Customising-prompts.md b/docs/pages/Guides/Customising-prompts.md index 6cfbbff7..5e7430d7 100644 --- a/docs/pages/Guides/Customising-prompts.md +++ b/docs/pages/Guides/Customising-prompts.md @@ -2,7 +2,7 @@ To customize the main prompt for DocsGPT, follow these steps: -1. Navigate to `/application/prompt/combine_prompt.txt`. +1. Navigate to `/application/prompts/combine_prompt.txt`. 2. Edit the `combine_prompt.txt` file to modify the prompt text. You can experiment with different phrasings and structures to see how the model responds. From 1a62a773aeb509503045346bbe88933da5d8b2b7 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 10:40:19 +0530 Subject: [PATCH 02/10] Update react-widget.md --- docs/pages/Extensions/react-widget.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/pages/Extensions/react-widget.md b/docs/pages/Extensions/react-widget.md index 4bc40854..de585581 100644 --- a/docs/pages/Extensions/react-widget.md +++ b/docs/pages/Extensions/react-widget.md @@ -43,4 +43,5 @@ export default function MyApp({ Component, pageProps }) { } ``` +For more information about React, refer to this [link here](https://react.dev/learn) From 153d12d93f202309ae009ff6d0acfe736e2b74d5 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 10:47:35 +0530 Subject: [PATCH 03/10] Update How-to-use-different-LLM.md --- docs/pages/Guides/How-to-use-different-LLM.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/pages/Guides/How-to-use-different-LLM.md b/docs/pages/Guides/How-to-use-different-LLM.md index c300bef3..6c7e08a9 100644 --- a/docs/pages/Guides/How-to-use-different-LLM.md +++ b/docs/pages/Guides/How-to-use-different-LLM.md @@ -19,12 +19,12 @@ You can omit the keys if users provide their own. Ensure you set `LLM_NAME` and ## Step 2: Choose Your Models **Options for `LLM_NAME`:** -- openai -- manifest -- cohere -- Arc53/docsgpt-14b -- Arc53/docsgpt-7b-falcon -- llama.cpp +- OpenAI ([More details](https://platform.openai.com/docs/models)) +- manifest ([More details](https://python.langchain.com/docs/integrations/llms/manifest)) +- cohere ([More details](https://docs.cohere.com/docs/llmu)) +- Arc53/docsgpt-14b ([More details](https://huggingface.co/Arc53/docsgpt-14b)) +- Arc53/docsgpt-7b-falcon ([More details](https://huggingface.co/Arc53/docsgpt-7b-falcon)) +- llama.cpp ([More details](https://python.langchain.com/docs/integrations/llms/llamacpp)) **Options for `EMBEDDINGS_NAME`:** - openai_text-embedding-ada-002 From b68b214d08490f0bed475f38012404a67f0c054c Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 10:56:57 +0530 Subject: [PATCH 04/10] Update My-AI-answers-questions-using-external-knowledge.md --- .../Guides/My-AI-answers-questions-using-external-knowledge.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md b/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md index a546116e..503d18c9 100644 --- a/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md +++ b/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md @@ -1,3 +1,5 @@ +## Avoiding hallucinations + If your AI uses external knowledge and is not explicit enough, it is ok, because we try to make DocsGPT friendly. But if you want to adjust it, here is a simple way:- From 2e6a5c05254b132990dd4f0f4bac8a32c2f14b51 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 10:57:24 +0530 Subject: [PATCH 05/10] Update My-AI-answers-questions-using-external-knowledge.md --- .../Guides/My-AI-answers-questions-using-external-knowledge.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md b/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md index 503d18c9..99e3c757 100644 --- a/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md +++ b/docs/pages/Guides/My-AI-answers-questions-using-external-knowledge.md @@ -1,4 +1,4 @@ -## Avoiding hallucinations +# Avoiding hallucinations If your AI uses external knowledge and is not explicit enough, it is ok, because we try to make DocsGPT friendly. From 1811cff1f91381332d82a5f623138658abff474b Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 10:59:32 +0530 Subject: [PATCH 06/10] Rename Hosting-the-app.md to Hosting-DocsGPT.md --- docs/pages/Deploying/{Hosting-the-app.md => Hosting-DocsGPT.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/pages/Deploying/{Hosting-the-app.md => Hosting-DocsGPT.md} (100%) diff --git a/docs/pages/Deploying/Hosting-the-app.md b/docs/pages/Deploying/Hosting-DocsGPT.md similarity index 100% rename from docs/pages/Deploying/Hosting-the-app.md rename to docs/pages/Deploying/Hosting-DocsGPT.md From 32fa86adaada8e6115d90f5145ce6ff2b872b5e6 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 11:11:41 +0530 Subject: [PATCH 07/10] Update _meta.json --- docs/pages/Deploying/_meta.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/Deploying/_meta.json b/docs/pages/Deploying/_meta.json index bcc9bcde..55a8e77c 100644 --- a/docs/pages/Deploying/_meta.json +++ b/docs/pages/Deploying/_meta.json @@ -1,5 +1,5 @@ { - "Hosting-the-app": { + "Hosting-DocsGPT": { "title": "☁️ Hosting DocsGPT", "href": "/Deploying/Hosting-the-app" }, @@ -11,4 +11,4 @@ "title": "🚂Deploying on Rainway", "href": "/Deploying/Railway-Deploying" } -} \ No newline at end of file +} From 12bd7dc44ff9e6ffb10fbc72dea843f8cd5dba67 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 11:14:30 +0530 Subject: [PATCH 08/10] Update _meta.json --- docs/pages/Deploying/_meta.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Deploying/_meta.json b/docs/pages/Deploying/_meta.json index 55a8e77c..db262e59 100644 --- a/docs/pages/Deploying/_meta.json +++ b/docs/pages/Deploying/_meta.json @@ -1,7 +1,7 @@ { "Hosting-DocsGPT": { "title": "☁️ Hosting DocsGPT", - "href": "/Deploying/Hosting-the-app" + "href": "/Deploying/Hosting-DocsGPT" }, "Quickstart": { "title": "⚡️Quickstart", From 9133a56d2a92b42f154a5227783fe6fc28ed9b66 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 11:16:26 +0530 Subject: [PATCH 09/10] Update _meta.json --- docs/pages/Deploying/_meta.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/Deploying/_meta.json b/docs/pages/Deploying/_meta.json index db262e59..0e91f35e 100644 --- a/docs/pages/Deploying/_meta.json +++ b/docs/pages/Deploying/_meta.json @@ -1,7 +1,7 @@ { - "Hosting-DocsGPT": { + "Hosting-the-app": { "title": "☁️ Hosting DocsGPT", - "href": "/Deploying/Hosting-DocsGPT" + "href": "/Deploying/Hosting-the-app" }, "Quickstart": { "title": "⚡️Quickstart", From aaeed646210ca16eaa4043dce29ac675850cfa90 Mon Sep 17 00:00:00 2001 From: Pronay Debnath Date: Thu, 26 Oct 2023 11:17:19 +0530 Subject: [PATCH 10/10] Update and rename Hosting-DocsGPT.md to Hosting-the-app.md --- docs/pages/Deploying/{Hosting-DocsGPT.md => Hosting-the-app.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename docs/pages/Deploying/{Hosting-DocsGPT.md => Hosting-the-app.md} (97%) diff --git a/docs/pages/Deploying/Hosting-DocsGPT.md b/docs/pages/Deploying/Hosting-the-app.md similarity index 97% rename from docs/pages/Deploying/Hosting-DocsGPT.md rename to docs/pages/Deploying/Hosting-the-app.md index 31c3f55a..9550e810 100644 --- a/docs/pages/Deploying/Hosting-DocsGPT.md +++ b/docs/pages/Deploying/Hosting-the-app.md @@ -1,6 +1,6 @@ # Self-hosting DocsGPT on Amazon Lightsail -Here's a step-by-step guide on how to setup an Amazon Lightsail instance to host DocsGPT. +Here's a step-by-step guide on how to set up an Amazon Lightsail instance to host DocsGPT. ## Configuring your instance