From 5bbf6d2ae9afa5744a89f2c1de8d9204c68c96e2 Mon Sep 17 00:00:00 2001
From: Digvijay Shelar <82649533+shelar1423@users.noreply.github.com>
Date: Thu, 5 Oct 2023 20:38:02 +0530
Subject: [PATCH 1/8] Update README.md
---
README.md | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index aba1401f..b734af6c 100644
--- a/README.md
+++ b/README.md
@@ -56,17 +56,19 @@ If you don't have enough resources to run it you can use bitsnbytes to quantize
## Useful links
- [Live preview](https://docsgpt.arc53.com/)
-
- [Join Our Discord](https://discord.gg/n5BX8dh8rU)
-
- [Guides](https://docs.docsgpt.co.uk/)
+
[Live preview](https://docsgpt.arc53.com/)
- [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
- [How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
+
[Join Our Discord](https://discord.gg/n5BX8dh8rU)
- [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
+
[Guides](https://docs.docsgpt.co.uk/)
+
+
+
[Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
+
+
[How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
+
+
[How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
## Project structure
From 35fef11d2a3d3766a18a0bb2a4d6416e3ead4ca2 Mon Sep 17 00:00:00 2001
From: Digvijay Shelar <82649533+shelar1423@users.noreply.github.com>
Date: Fri, 6 Oct 2023 22:40:46 +0530
Subject: [PATCH 2/8] Update README.md
---
README.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index b734af6c..5c115b4d 100644
--- a/README.md
+++ b/README.md
@@ -56,19 +56,21 @@ If you don't have enough resources to run it you can use bitsnbytes to quantize
## Useful links
-
[Live preview](https://docsgpt.arc53.com/)
+
[Live preview](https://docsgpt.arc53.com/)
[Join Our Discord](https://discord.gg/n5BX8dh8rU)
-
[Guides](https://docs.docsgpt.co.uk/)
+
[Guides](https://docs.docsgpt.co.uk/)
-
[Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
+
[Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
+
+
[How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
+
+
[How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
-
[How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
-
[How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
## Project structure
From 6758b51617a9cbda1d88ff569d6fa26f709019f5 Mon Sep 17 00:00:00 2001
From: Digvijay Shelar <82649533+shelar1423@users.noreply.github.com>
Date: Sun, 8 Oct 2023 11:20:28 +0530
Subject: [PATCH 3/8] Update README.md
---
README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 4b2247bc..543bfb12 100644
--- a/README.md
+++ b/README.md
@@ -55,19 +55,19 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
## Useful links
+ - ππ₯ [Live preview](https://docsgpt.arc53.com/)
+
+ -
[Join our Discord](https://discord.gg/n5BX8dh8rU)
+
+ - ππ [Guides](https://docs.docsgpt.co.uk/)
+ - π©βπ»π¨βπ»πͺ [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
-
[Join Our Discord](https://discord.gg/n5BX8dh8rU)
+ - ποΈπ [How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
-
[Guides](https://docs.docsgpt.co.uk/)
+ - π πΎπ [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
-
[Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
-
-
[How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
-
-
[How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
-
From fc50bb6e57893fd9ea712c049bb9e51e419930c6 Mon Sep 17 00:00:00 2001
From: "beKool.sh" <76424367+beKoool@users.noreply.github.com>
Date: Sun, 8 Oct 2023 17:10:33 +0545
Subject: [PATCH 4/8] Add Backlink to Vector Stores
---
docs/pages/Developing/API-docs.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md
index eabd29c0..99d98965 100644
--- a/docs/pages/Developing/API-docs.md
+++ b/docs/pages/Developing/API-docs.md
@@ -104,7 +104,7 @@ fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4f
Responses:
There are two types of responses:
-1. while task it still running, where "current" will show progress from 0 to 100
+1. While task is still running, where "current" will show progress from 0 to 100:
```json
{
"result": {
@@ -114,7 +114,7 @@ There are two types of responses:
}
```
-2. When task is completed
+2. When task is completed:
```json
{
"result": {
@@ -133,7 +133,7 @@ There are two types of responses:
```
### /api/delete_old
-Deletes old vectorstores:
+Deletes old [Vector stores](https://python.langchain.com/docs/modules/data_connection/vectorstores/):
```js
// Task status (GET http://127.0.0.1:5000/api/docs_check)
fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", {
From 261c674832e4a61655ab82d574c5664feeb81e14 Mon Sep 17 00:00:00 2001
From: "beKool.sh" <76424367+beKoool@users.noreply.github.com>
Date: Mon, 9 Oct 2023 05:48:27 +0545
Subject: [PATCH 5/8] Update API-docs.md
---
docs/pages/Developing/API-docs.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md
index 99d98965..26ad6401 100644
--- a/docs/pages/Developing/API-docs.md
+++ b/docs/pages/Developing/API-docs.md
@@ -133,7 +133,7 @@ There are two types of responses:
```
### /api/delete_old
-Deletes old [Vector stores](https://python.langchain.com/docs/modules/data_connection/vectorstores/):
+Deletes old Vector stores:
```js
// Task status (GET http://127.0.0.1:5000/api/docs_check)
fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", {
From f88806fc3c10977cff952a67a56964246eceebc7 Mon Sep 17 00:00:00 2001
From: Digvijay Shelar <82649533+shelar1423@users.noreply.github.com>
Date: Mon, 9 Oct 2023 07:26:34 +0530
Subject: [PATCH 6/8] Update README.md
---
README.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index f326f426..3784278d 100644
--- a/README.md
+++ b/README.md
@@ -57,16 +57,15 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
- ππ₯ [Live preview](https://docsgpt.arc53.com/)
- -
[Join our Discord](https://discord.gg/n5BX8dh8rU)
+ - π¬π[Join our Discord](https://discord.gg/n5BX8dh8rU)
- ππ [Guides](https://docs.docsgpt.co.uk/)
- - π©βπ»π¨βπ»πͺ [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
+ - π©βπ»π¨βπ» [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
- ποΈπ [How to use any other documentation](https://docs.docsgpt.co.uk/Guides/How-to-train-on-other-documentation)
- - π πΎπ [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
-
+ - π π [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
From f8ca6c019f5d8fdea8a5fe6d08b84d861cd9e609 Mon Sep 17 00:00:00 2001
From: Shuvadipta Das
Date: Mon, 9 Oct 2023 09:46:54 +0530
Subject: [PATCH 7/8] Update
My-AI-answers-questions-using-external-knowledge.md
---
.../My-AI-answers-questions-using-external-knowledge.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
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 fb15835f..a546116e 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,10 +1,10 @@
-If your AI uses external knowledge and is not explicit enough, it is ok, because we try to make docsgpt friendly.
+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.
+But if you want to adjust it, here is a simple way:-
-Got to `application/prompts/chat_combine_prompt.txt`
+- Got to `application/prompts/chat_combine_prompt.txt`
-And change it to
+- And change it to
```
From cb0e4b6e870dde050c04673ce186817a62004d15 Mon Sep 17 00:00:00 2001
From: Alex
Date: Mon, 9 Oct 2023 15:37:40 +0100
Subject: [PATCH 8/8] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 05a5feb7..55b54482 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ Say goodbye to time-consuming manual searches, and let