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 01/77] Update README.md
---
README.md | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index aba1401..b734af6 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 425a8a641204fa636b7b3ee1236161a1316b8cf6 Mon Sep 17 00:00:00 2001
From: Shuvadipta Das
Date: Fri, 6 Oct 2023 21:39:18 +0530
Subject: [PATCH 02/77] Update How-to-train-on-other-documentation.md
---
docs/pages/Guides/How-to-train-on-other-documentation.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/pages/Guides/How-to-train-on-other-documentation.md b/docs/pages/Guides/How-to-train-on-other-documentation.md
index c9549ae..0a39929 100644
--- a/docs/pages/Guides/How-to-train-on-other-documentation.md
+++ b/docs/pages/Guides/How-to-train-on-other-documentation.md
@@ -12,9 +12,9 @@ It currently uses OPEN_AI to create vector store, so make sure your documentatio
You can usually find documentation on github in `docs/` folder for most open-source projects.
### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory
-Name it `inputs/`
-Put all your .rst/.md files in there
-The search is recursive, so you don't need to flatten them
+- Name it `inputs/`
+- Put all your .rst/.md files in there
+- The search is recursive, so you don't need to flatten them
If there are no .rst/.md files just convert whatever you find to txt and feed it. (don't forget to change the extension in script)
@@ -56,4 +56,4 @@ You can learn more about options while running ingest.py by running:
| | |
| **convert** | Creates documentation in .md format from source code |
| --dir TEXT | Path to a directory with source code. E.g. --dir inputs [default: inputs] |
-| --formats TEXT | Source code language from which to create documentation. Supports py, js and java. E.g. --formats py [default: py] |
\ No newline at end of file
+| --formats TEXT | Source code language from which to create documentation. Supports py, js and java. E.g. --formats py [default: py] |
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 03/77] Update README.md
---
README.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index b734af6..5c115b4 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 bdfcf6591e58b8a5984108c4877e58a4dcf1f609 Mon Sep 17 00:00:00 2001
From: Nick Rogers
Date: Fri, 6 Oct 2023 21:20:40 -0700
Subject: [PATCH 04/77] Fix missing documentation for using Llama_cpp
---
docs/pages/Guides/How-to-use-different-LLM.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/docs/pages/Guides/How-to-use-different-LLM.md b/docs/pages/Guides/How-to-use-different-LLM.md
index aa5815f..f9a2fec 100644
--- a/docs/pages/Guides/How-to-use-different-LLM.md
+++ b/docs/pages/Guides/How-to-use-different-LLM.md
@@ -21,9 +21,13 @@ By default, we use OpenAI's models but if you want to change it or even run it l
You don't need to provide keys if you are happy with users providing theirs, so make sure you set `LLM_NAME` and `EMBEDDINGS_NAME`.
Options:
-LLM_NAME (openai, manifest, cohere, Arc53/docsgpt-14b, Arc53/docsgpt-7b-falcon)
+LLM_NAME (openai, manifest, cohere, Arc53/docsgpt-14b, Arc53/docsgpt-7b-falcon, llama.cpp)
EMBEDDINGS_NAME (openai_text-embedding-ada-002, huggingface_sentence-transformers/all-mpnet-base-v2, huggingface_hkunlp/instructor-large, cohere_medium)
+If using Llama, set the `EMBEDDINGS_NAME` to `huggingface_sentence-transformers/all-mpnet-base-v2`.
+
+Alternatively, if you wish to run Llama locally, you can run `setup.sh` and choose option 1 when prompted.
+
That's it!
### Hosting everything locally and privately (for using our optimised open-source models)
From 36528fceabed84fa8b8fea2fdbb241c120e3365a Mon Sep 17 00:00:00 2001
From: staticGuru
Date: Sat, 7 Oct 2023 12:20:47 +0530
Subject: [PATCH 05/77] add issue fixes
---
frontend/src/Hero.tsx | 52 +++++++++++-----------
frontend/src/conversation/Conversation.tsx | 2 +-
2 files changed, 26 insertions(+), 28 deletions(-)
diff --git a/frontend/src/Hero.tsx b/frontend/src/Hero.tsx
index df0ad28..0644da6 100644
--- a/frontend/src/Hero.tsx
+++ b/frontend/src/Hero.tsx
@@ -5,26 +5,28 @@ export default function Hero({ className = '' }: { className?: string }) {
DocsGPT
π¦
-
+
Welcome to DocsGPT, your technical documentation assistant!
-
+
Enter a query related to the information in the documentation you
- selected to receive and we will provide you with the most relevant
- answers.
+ selected to receive
+ and we will provide you with the most relevant answers.
-
+
Start by entering your query in the input field below and we will do the
rest!
-
-
-
-
-
- Chat with Your Data
-
-
+
+
+
+
+
Chat with Your Data
+
DocsGPT will use your data to answer questions. Whether its
documentation, source code, or Microsoft files, DocsGPT allows you
to have interactive conversations and find answers based on the
@@ -33,13 +35,11 @@ export default function Hero({ className = '' }: { className?: string }) {
-
-
-
-
- Secure Data Storage
-
-
+
+
+
+
Secure Data Storage
+
The security of your data is our top priority. DocsGPT ensures the
utmost protection for your sensitive information. With secure data
storage and privacy measures in place, you can trust that your
@@ -47,17 +47,15 @@ export default function Hero({ className = '' }: { className?: string }) {
-
-
+
+
-
- Open Source Code
-
-
+
Open Source Code
+
DocsGPT is built on open source principles, promoting transparency
and collaboration. The source code is freely available, enabling
developers to contribute, enhance, and customize the app to meet
diff --git a/frontend/src/conversation/Conversation.tsx b/frontend/src/conversation/Conversation.tsx
index ab43576..e6b5d9c 100644
--- a/frontend/src/conversation/Conversation.tsx
+++ b/frontend/src/conversation/Conversation.tsx
@@ -134,7 +134,7 @@ export default function Conversation() {
return (
Date: Sat, 7 Oct 2023 14:15:17 +0530
Subject: [PATCH 06/77] Update HACKTOBERFEST.md
Improved the HACKTOBERFEST.md file.
Fixed and added 7 links.
---
HACKTOBERFEST.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md
index 1a39e56..6265ddd 100644
--- a/HACKTOBERFEST.md
+++ b/HACKTOBERFEST.md
@@ -17,14 +17,14 @@ Familiarize yourself with the current contributions and our [Roadmap](https://gi
Deciding to contribute with code? Here are some insights based on the area of your interest:
- Frontend (βοΈReact, Vite):
- - Most of the code is located in `/frontend` folder. You can also check out our React extension in /extensions/react-widget.
+ - Most of the code is located in [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder. You can also check out our React extension in [/extensions/react-widget](https://github.com/arc53/DocsGPT/tree/main/extensions/react-widget).
- For design references, here's the [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1).
- Ensure you adhere to the established guidelines.
- Backend (πPython):
- - Focus on `/application` or `/scripts`. However, avoid the files ingest_rst.py and ingest_rst_sphinx.py, as they will soon be deprecated.
+ - Focus on [/application](https://github.com/arc53/DocsGPT/tree/main/application) or [/scripts](https://github.com/arc53/DocsGPT/tree/main/scripts). However, avoid the files [ingest_rst.py](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst.py) and [ingest_rst_sphinx.py](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst_sphinx.py), as they will soon be deprecated.
- Newly added code should come with relevant unit tests (pytest).
- - Refer to the `/tests` folder for test suites.
+ - Refer to the [/tests](https://github.com/arc53/DocsGPT/tree/main/tests) folder for test suites.
Check out our [Contributing Guidelines](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
From a8317ccacd9e786ff83e1602aced045da352b90a Mon Sep 17 00:00:00 2001
From: Pratik Gupta <91310568+GuptaPratik02@users.noreply.github.com>
Date: Sat, 7 Oct 2023 14:37:54 +0530
Subject: [PATCH 07/77] Update README.md
Fixed and added the necessary links in README file
---
README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index edeb7b6..16706df 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,9 @@
- DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers.
+ DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers.
-Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.
+Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.
@@ -89,15 +89,15 @@ It will install all the dependencies and allow you to download the local model o
Otherwise, refer to this Guide:
1. Download and open this repository with `git clone https://github.com/arc53/DocsGPT.git`
-2. Create a `.env` file in your root directory and set the env variable `OPENAI_API_KEY` with your OpenAI API key and `VITE_API_STREAMING` to true or false, depending on if you want streaming answers or not.
+2. Create a `.env` file in your root directory and set the env variable `OPENAI_API_KEY` with your [OpenAI API key](https://platform.openai.com/account/api-keys) and `VITE_API_STREAMING` to true or false, depending on if you want streaming answers or not.
It should look like this inside:
```
API_KEY=Yourkey
VITE_API_STREAMING=true
```
- See optional environment variables in the `/.env-template` and `/application/.env_sample` files.
-3. Run `./run-with-docker-compose.sh`.
+ See optional environment variables in the [/.env-template](https://github.com/arc53/DocsGPT/blob/main/.env-template) and [/application/.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) files.
+3. Run [./run-with-docker-compose.sh](https://github.com/arc53/DocsGPT/blob/main/run-with-docker-compose.sh).
4. Navigate to http://localhost:5173/.
To stop, just run `Ctrl + C`.
@@ -105,7 +105,7 @@ To stop, just run `Ctrl + C`.
## Development environments
### Spin up mongo and redis
-For development, only two containers are used from `docker-compose.yaml` (by deleting all services except for Redis and Mongo).
+For development, only two containers are used from [docker-compose.yaml](https://github.com/arc53/DocsGPT/blob/main/docker-compose.yaml) (by deleting all services except for Redis and Mongo).
See file [docker-compose-dev.yaml](./docker-compose-dev.yaml).
Run
@@ -119,7 +119,7 @@ docker compose -f docker-compose-dev.yaml up -d
Make sure you have Python 3.10 or 3.11 installed.
1. Export required environment variables or prepare a `.env` file in the `/application` folder:
- - Copy `.env_sample` and create `.env` with your OpenAI API token for the `API_KEY` and `EMBEDDINGS_KEY` fields.
+ - Copy [.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) and create `.env` with your OpenAI API token for the `API_KEY` and `EMBEDDINGS_KEY` fields.
(check out [`application/core/settings.py`](application/core/settings.py) if you want to see more config options.)
@@ -139,7 +139,7 @@ pip install -r application/requirements.txt
Make sure you have Node version 16 or higher.
-1. Navigate to the `/frontend` folder.
+1. Navigate to the [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder.
2. Install dependencies by running `npm install`.
3. Run the app using `npm run dev`.
From e034fc12ebb171905f5e3312968f38dcd7082297 Mon Sep 17 00:00:00 2001
From: Pratik Gupta <91310568+GuptaPratik02@users.noreply.github.com>
Date: Sat, 7 Oct 2023 14:46:56 +0530
Subject: [PATCH 08/77] Update CONTRIBUTING.md
Fixed and added the necessary links in contributing file
---
CONTRIBUTING.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b759fd4..1e127f0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,14 +25,14 @@ We have a frontend in React (Vite) and backend in Python.
### If you are looking to contribute to frontend (βοΈReact, Vite):
-- The current frontend is being migrated from `/application` to `/frontend` with a new design, so please contribute to the new one.
+- The current frontend is being migrated from [`/application`](https://github.com/arc53/DocsGPT/tree/main/application) to [`/frontend`](https://github.com/arc53/DocsGPT/tree/main/frontend) with a new design, so please contribute to the new one.
- Check out this [milestone](https://github.com/arc53/DocsGPT/milestone/1) and its issues.
- The Figma design can be found [here](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1).
Please try to follow the guidelines.
### If you are looking to contribute to Backend (π Python):
-- Check out our issues and contribute to `/application` or `/scripts` (ignore old `ingest_rst.py` `ingest_rst_sphinx.py` files; they will be deprecated soon).
+- Check out our issues and contribute to [`/application`](https://github.com/arc53/DocsGPT/tree/main/application) or [`/scripts`](https://github.com/arc53/DocsGPT/tree/main/scripts) (ignore old [`ingest_rst.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst.py) [`ingest_rst_sphinx.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst_sphinx.py) files; they will be deprecated soon).
- All new code should be covered with unit tests ([pytest](https://github.com/pytest-dev/pytest)). Please find tests under [`/tests`](https://github.com/arc53/DocsGPT/tree/main/tests) folder.
- Before submitting your PR, ensure it is queryable after ingesting some test data.
From 66b5ac8ff1174605a7c1bf4bff58ab40085b7ccf Mon Sep 17 00:00:00 2001
From: Pratik Gupta <91310568+GuptaPratik02@users.noreply.github.com>
Date: Sat, 7 Oct 2023 14:51:22 +0530
Subject: [PATCH 09/77] Update HACKTOBERFEST.md
Improvements
---
HACKTOBERFEST.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md
index 6265ddd..b164661 100644
--- a/HACKTOBERFEST.md
+++ b/HACKTOBERFEST.md
@@ -17,14 +17,14 @@ Familiarize yourself with the current contributions and our [Roadmap](https://gi
Deciding to contribute with code? Here are some insights based on the area of your interest:
- Frontend (βοΈReact, Vite):
- - Most of the code is located in [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder. You can also check out our React extension in [/extensions/react-widget](https://github.com/arc53/DocsGPT/tree/main/extensions/react-widget).
+ - Most of the code is located in [`/frontend`](https://github.com/arc53/DocsGPT/tree/main/frontend) folder. You can also check out our React extension in [`/extensions/react-widget`](https://github.com/arc53/DocsGPT/tree/main/extensions/react-widget).
- For design references, here's the [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1).
- Ensure you adhere to the established guidelines.
- Backend (πPython):
- - Focus on [/application](https://github.com/arc53/DocsGPT/tree/main/application) or [/scripts](https://github.com/arc53/DocsGPT/tree/main/scripts). However, avoid the files [ingest_rst.py](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst.py) and [ingest_rst_sphinx.py](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst_sphinx.py), as they will soon be deprecated.
+ - Focus on [`/application`](https://github.com/arc53/DocsGPT/tree/main/application) or [`/scripts`](https://github.com/arc53/DocsGPT/tree/main/scripts). However, avoid the files [`ingest_rst.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst.py) and [`ingest_rst_sphinx.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst_sphinx.py), as they will soon be deprecated.
- Newly added code should come with relevant unit tests (pytest).
- - Refer to the [/tests](https://github.com/arc53/DocsGPT/tree/main/tests) folder for test suites.
+ - Refer to the [`/tests`](https://github.com/arc53/DocsGPT/tree/main/tests) folder for test suites.
Check out our [Contributing Guidelines](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
From a17390c157a643e99dc9c53f5234becfaecfb32c Mon Sep 17 00:00:00 2001
From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com>
Date: Sat, 7 Oct 2023 21:37:58 +0530
Subject: [PATCH 10/77] Update CONTRIBUTING.md
i made it easy to understand
---
CONTRIBUTING.md | 27 +++++++++++++--------------
1 file changed, 13 insertions(+), 14 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b759fd4..d8e3559 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,27 +1,27 @@
# Welcome to DocsGPT Contributing Guidelines
-Thank you for choosing this project to contribute to. We are all very grateful!
+Thank you for choosing to contribute to our project! We greatly appreciate your help!
### [π Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! π](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md)
# We accept different types of contributions
-π£ Discussions - where you can start a new topic or answer some questions
+π£ Discussions - Engage in conversations, start new topics, or help answer questions.
-π Issues - This is how we track tasks, sometimes it is bugs that need fixing, and sometimes it is new features
+π Issues - This is where we keep track of tasks. It could be bug fixes or suggestions for new features.
-π οΈ Pull requests - This is how you can suggest changes to our repository, to work on existing issues or add new features
+π οΈ Pull requests - Suggest changes to our repository, either by working on existing issues or adding new features.
-π Wiki - where we have our documentation
+π Wiki - This is where our documentation resides.
## π Issues and Pull requests
-We value contributions to our issues in the form of discussion or suggestions. We recommend that you check out existing issues and our [roadmap](https://github.com/orgs/arc53/projects/2).
+We highly value contributions in the form of discussions or suggestions. We recommend taking a look at existing issues and our [roadmap](https://github.com/orgs/arc53/projects/2).
-If you want to contribute by writing code, there are a few things that you should know before doing it:
+If you're interested in contributing code, here are some important things to know:
-We have a frontend in React (Vite) and backend in Python.
+We have a frontend built with React (Vite) and a backend in Python.
### If you are looking to contribute to frontend (βοΈReact, Vite):
@@ -32,10 +32,10 @@ We have a frontend in React (Vite) and backend in Python.
Please try to follow the guidelines.
### If you are looking to contribute to Backend (π Python):
-- Check out our issues and contribute to `/application` or `/scripts` (ignore old `ingest_rst.py` `ingest_rst_sphinx.py` files; they will be deprecated soon).
+- Review our issues and contribute to /application or /scripts (please disregard old ingest_rst.py and ingest_rst_sphinx.py files; they will be phased out soon).
- All new code should be covered with unit tests ([pytest](https://github.com/pytest-dev/pytest)). Please find tests under [`/tests`](https://github.com/arc53/DocsGPT/tree/main/tests) folder.
-- Before submitting your PR, ensure it is queryable after ingesting some test data.
-
+- Before submitting your Pull Request, ensure it can be queried after ingesting some test data.
+
### Testing
To run unit tests from the root of the repository, execute:
@@ -44,9 +44,8 @@ python -m pytest
```
### Workflow:
-Create a fork, make changes on your forked repository, and submit changes as a pull request.
+Fork the repository, make your changes on your forked version, and then submit those changes as a pull request.
## Questions/collaboration
-Please join our [Discord](https://discord.gg/n5BX8dh8rU). Don't hesitate; we are very friendly and welcoming to new contributors.
-
+Feel free to join our [Discord](https://discord.gg/n5BX8dh8rU). We're very friendly and welcoming to new contributors, so don't hesitate to reach out.
# Thank you so much for considering contributing to DocsGPT!π
From accd65a26ab47114852fc295d5af6097e267e341 Mon Sep 17 00:00:00 2001
From: ManishMadan2882
Date: Sun, 8 Oct 2023 05:27:03 +0530
Subject: [PATCH 11/77] added the copy msg feature
---
frontend/package-lock.json | 26 +++++++++++++++++++
frontend/package.json | 1 +
frontend/src/assets/copy.svg | 3 +++
.../src/conversation/ConversationBubble.tsx | 7 +++++
4 files changed, 37 insertions(+)
create mode 100644 frontend/src/assets/copy.svg
diff --git a/frontend/package-lock.json b/frontend/package-lock.json
index 8cf969d..7c08dfb 100644
--- a/frontend/package-lock.json
+++ b/frontend/package-lock.json
@@ -11,6 +11,7 @@
"@reduxjs/toolkit": "^1.9.2",
"@vercel/analytics": "^0.1.10",
"react": "^18.2.0",
+ "react-copy-to-clipboard": "^5.1.0",
"react-dom": "^18.2.0",
"react-dropzone": "^14.2.3",
"react-markdown": "^8.0.7",
@@ -2248,6 +2249,14 @@
"integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==",
"dev": true
},
+ "node_modules/copy-to-clipboard": {
+ "version": "3.3.3",
+ "resolved": "https://registry.npmjs.org/copy-to-clipboard/-/copy-to-clipboard-3.3.3.tgz",
+ "integrity": "sha512-2KV8NhB5JqC3ky0r9PMCAZKbUHSwtEo4CwCs0KXgruG43gX5PMqDEBbVU4OUzw2MuAWUfsuFmWvEKG5QRfSnJA==",
+ "dependencies": {
+ "toggle-selection": "^1.0.6"
+ }
+ },
"node_modules/cosmiconfig": {
"version": "7.1.0",
"resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.1.0.tgz",
@@ -6072,6 +6081,18 @@
"node": ">=0.10.0"
}
},
+ "node_modules/react-copy-to-clipboard": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/react-copy-to-clipboard/-/react-copy-to-clipboard-5.1.0.tgz",
+ "integrity": "sha512-k61RsNgAayIJNoy9yDsYzDe/yAZAzEbEgcz3DZMhF686LEyukcE1hzurxe85JandPUG+yTfGVFzuEw3xt8WP/A==",
+ "dependencies": {
+ "copy-to-clipboard": "^3.3.1",
+ "prop-types": "^15.8.1"
+ },
+ "peerDependencies": {
+ "react": "^15.3.0 || 16 || 17 || 18"
+ }
+ },
"node_modules/react-dom": {
"version": "18.2.0",
"resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.2.0.tgz",
@@ -6907,6 +6928,11 @@
"node": ">=8.0"
}
},
+ "node_modules/toggle-selection": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/toggle-selection/-/toggle-selection-1.0.6.tgz",
+ "integrity": "sha512-BiZS+C1OS8g/q2RRbJmy59xpyghNBqrr6k5L/uKBGRsTfxmu3ffiRnd8mlGPUVayg8pvfi5urfnu8TU7DVOkLQ=="
+ },
"node_modules/trim-lines": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz",
diff --git a/frontend/package.json b/frontend/package.json
index 66d14dd..9dcbf4a 100644
--- a/frontend/package.json
+++ b/frontend/package.json
@@ -22,6 +22,7 @@
"@reduxjs/toolkit": "^1.9.2",
"@vercel/analytics": "^0.1.10",
"react": "^18.2.0",
+ "react-copy-to-clipboard": "^5.1.0",
"react-dom": "^18.2.0",
"react-dropzone": "^14.2.3",
"react-markdown": "^8.0.7",
diff --git a/frontend/src/assets/copy.svg b/frontend/src/assets/copy.svg
new file mode 100644
index 0000000..d0da885
--- /dev/null
+++ b/frontend/src/assets/copy.svg
@@ -0,0 +1,3 @@
+
diff --git a/frontend/src/conversation/ConversationBubble.tsx b/frontend/src/conversation/ConversationBubble.tsx
index b74c65f..3f38ee9 100644
--- a/frontend/src/conversation/ConversationBubble.tsx
+++ b/frontend/src/conversation/ConversationBubble.tsx
@@ -4,7 +4,9 @@ import { FEEDBACK, MESSAGE_TYPE } from './conversationModels';
import Alert from './../assets/alert.svg';
import { ReactComponent as Like } from './../assets/like.svg';
import { ReactComponent as Dislike } from './../assets/dislike.svg';
+import { ReactComponent as Copy } from './../assets/copy.svg';
import ReactMarkdown from 'react-markdown';
+import copy from 'copy-to-clipboard';
import { Prism as SyntaxHighlighter } from 'react-syntax-highlighter';
import { vscDarkPlus } from 'react-syntax-highlighter/dist/cjs/styles/prism';
@@ -145,6 +147,11 @@ const ConversationBubble = forwardRef<
: 'md:invisible'
}`}
>
+ copy(message)}
+ >
Date: Sun, 8 Oct 2023 05:33:13 +0530
Subject: [PATCH 12/77] fix
---
frontend/src/About.tsx | 8 +++++---
frontend/src/conversation/ConversationBubble.tsx | 3 +--
2 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/frontend/src/About.tsx b/frontend/src/About.tsx
index 303708c..2365536 100644
--- a/frontend/src/About.tsx
+++ b/frontend/src/About.tsx
@@ -51,9 +51,11 @@ export default function About() {
- DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers.
+ DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers.
-Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.
+Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.
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 17/77] 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 eabd29c..99d9896 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 2993bd8c0526c2a11d4829ebb9bfcda3ec353433 Mon Sep 17 00:00:00 2001
From: Sanket Pol <68698332+sanketmp@users.noreply.github.com>
Date: Sun, 8 Oct 2023 17:02:44 +0530
Subject: [PATCH 18/77] add license link to readme.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 0fa6a7a..902b32a 100644
--- a/README.md
+++ b/README.md
@@ -166,6 +166,6 @@ We as members, contributors, and leaders, pledge to make participation in our co
## License
-The source code license is MIT, as described in the LICENSE file.
+The source code license is [MIT](https://opensource.org/license/mit/), as described in the [LICENSE](LICENSE) file.
Built with [π¦οΈπ LangChain](https://github.com/hwchase17/langchain)
From 396697ead2f0ae12bf080d468453e9a43d7bb250 Mon Sep 17 00:00:00 2001
From: staticGuru
Date: Sun, 8 Oct 2023 17:36:57 +0530
Subject: [PATCH 19/77] Query overlay text input issues
---
frontend/src/conversation/Conversation.tsx | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/frontend/src/conversation/Conversation.tsx b/frontend/src/conversation/Conversation.tsx
index e6b5d9c..d50ed85 100644
--- a/frontend/src/conversation/Conversation.tsx
+++ b/frontend/src/conversation/Conversation.tsx
@@ -81,7 +81,7 @@ export default function Conversation() {
responseView = (
)}
-
{
From e9883647665bfeb411fc605eee7a954309c1ac65 Mon Sep 17 00:00:00 2001
From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com>
Date: Sun, 8 Oct 2023 17:47:27 +0530
Subject: [PATCH 20/77] Update CONTRIBUTING.md
i made it easy to understand
---
CONTRIBUTING.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d8e3559..188a90d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Welcome to DocsGPT Contributing Guidelines
-Thank you for choosing to contribute to our project! We greatly appreciate your help!
+Thank you for choosing to contribute to DocsGPT! We greatly appreciate your help!
### [π Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! π](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md)
@@ -8,7 +8,7 @@ Thank you for choosing to contribute to our project! We greatly appreciate your
π£ Discussions - Engage in conversations, start new topics, or help answer questions.
-π Issues - This is where we keep track of tasks. It could be bug fixes or suggestions for new features.
+π Issues - This is where we keep track of tasks. It could be bug,fixes or suggestions for new features.
π οΈ Pull requests - Suggest changes to our repository, either by working on existing issues or adding new features.
@@ -17,7 +17,7 @@ Thank you for choosing to contribute to our project! We greatly appreciate your
## π Issues and Pull requests
-We highly value contributions in the form of discussions or suggestions. We recommend taking a look at existing issues and our [roadmap](https://github.com/orgs/arc53/projects/2).
+We value contributions in the form of discussions or suggestions. We recommend taking a look at existing issues and our [roadmap](https://github.com/orgs/arc53/projects/2).
If you're interested in contributing code, here are some important things to know:
@@ -32,7 +32,7 @@ We have a frontend built with React (Vite) and a backend in Python.
Please try to follow the guidelines.
### If you are looking to contribute to Backend (π Python):
-- Review our issues and contribute to /application or /scripts (please disregard old ingest_rst.py and ingest_rst_sphinx.py files; they will be phased out soon).
+- Review our issues and contribute to /application or /scripts (please disregard old ingest_rst.py and ingest_rst_sphinx.py files; they will be deprecated soon).
- All new code should be covered with unit tests ([pytest](https://github.com/pytest-dev/pytest)). Please find tests under [`/tests`](https://github.com/arc53/DocsGPT/tree/main/tests) folder.
- Before submitting your Pull Request, ensure it can be queried after ingesting some test data.
From c451d00eb4db238730070aa20e05fc28e401d812 Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 21:52:52 +0530
Subject: [PATCH 21/77] Update Hosting-the-app.md
---
docs/pages/Deploying/Hosting-the-app.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/pages/Deploying/Hosting-the-app.md b/docs/pages/Deploying/Hosting-the-app.md
index 7505f60..13296b4 100644
--- a/docs/pages/Deploying/Hosting-the-app.md
+++ b/docs/pages/Deploying/Hosting-the-app.md
@@ -18,7 +18,7 @@ After that, it is time to pick your Instance Image. We recommend using "Linux/Un
As for instance plan, it'll vary depending on your unique demands, but a "1 GB, 1vCPU, 40GB SSD and 2TB transfer" setup should cover most scenarios.
-Lastly, Identify your instance by giving it a unique name and then hit "Create instance".
+Lastly, identify your instance by giving it a unique name and then hit "Create instance".
PS: Once you create your instance, it'll likely take a few minutes for the setup to be completed.
@@ -42,7 +42,7 @@ A terminal window will pop up, and the first step will be to clone the DocsGPT g
#### Download the package information
-Once it has finished cloning the repository, it is time to download the package information from all sources. To do so simply enter the following command:
+Once it has finished cloning the repository, it is time to download the package information from all sources. To do so, simply enter the following command:
`sudo apt update`
@@ -64,7 +64,7 @@ Enter the following command to access the folder in which DocsGPT docker-compose
#### Prepare the environment
-Inside the DocsGPT folder create a `.env` file and copy the contents of `.env_sample` into it.
+Inside the DocsGPT folder, create a `.env` file and copy the contents of `.env_sample` into it.
`nano .env`
@@ -95,7 +95,7 @@ You're almost there! Now that all the necessary bits and pieces have been instal
Launching it for the first time will take a few minutes to download all the necessary dependencies and build.
-Once this is done you can go ahead and close the terminal window.
+Once this is done, you can go ahead and close the terminal window.
#### Enabling ports
From 4d5de8176ad34793b1035c3d3f6f975c67e90afd Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 21:55:43 +0530
Subject: [PATCH 22/77] Update Quickstart.md
---
docs/pages/Deploying/Quickstart.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md
index 2cc03c5..5ed37a5 100644
--- a/docs/pages/Deploying/Quickstart.md
+++ b/docs/pages/Deploying/Quickstart.md
@@ -1,7 +1,7 @@
## Launching Web App
Note: Make sure you have Docker installed
-On Mac OS or Linux just write:
+On macOS or Linux, just write:
`./setup.sh`
@@ -10,11 +10,11 @@ It will install all the dependencies and give you an option to download the loca
Otherwise, refer to this Guide:
1. Open and download this repository with `git clone https://github.com/arc53/DocsGPT.git`.
-2. Create a `.env` file in your root directory and set your `API_KEY` with your [OpenAI api key](https://platform.openai.com/account/api-keys).
+2. Create a `.env` file in your root directory and set your `API_KEY` with your [OpenAI API key](https://platform.openai.com/account/api-keys).
3. Run `docker-compose build && docker-compose up`.
4. Navigate to `http://localhost:5173/`.
-To stop just run `Ctrl + C`.
+To stop, just run `Ctrl + C`.
### Chrome Extension
From d2424ce540a7cd536669afb3add54c4040f9559a Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 21:59:27 +0530
Subject: [PATCH 23/77] Update API-docs.md
---
docs/pages/Developing/API-docs.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md
index eabd29c..1b908a8 100644
--- a/docs/pages/Developing/API-docs.md
+++ b/docs/pages/Developing/API-docs.md
@@ -18,7 +18,7 @@ fetch("http://127.0.0.1:5000/api/answer", {
.then(console.log.bind(console))
```
-In response you will get a json document like this one:
+In response, you will get a JSON document like this one:
```json
{
@@ -30,7 +30,7 @@ In response you will get a json document like this one:
### /api/docs_check
It will make sure documentation is loaded on a server (just run it every time user is switching between libraries (documentations)).
-It's a POST request that sends a JSON in body with 1 value. Here is a JavaScript fetch example:
+It's a POST request that sends a JSON in a body with 1 value. Here is a JavaScript fetch example:
```js
// answer (POST http://127.0.0.1:5000/api/docs_check)
@@ -45,7 +45,7 @@ fetch("http://127.0.0.1:5000/api/docs_check", {
.then(console.log.bind(console))
```
-In response you will get a json document like this one:
+In response, you will get a JSON document like this one:
```json
{
"status": "exists"
@@ -54,17 +54,17 @@ In response you will get a json document like this one:
### /api/combine
-Provides json that tells UI which vectors are available and where they are located with a simple get request.
+Provides JSON that tells UI which vectors are available and where they are located with a simple get request.
Response will include:
`date`, `description`, `docLink`, `fullName`, `language`, `location` (local or docshub), `model`, `name`, `version`.
-Example of json in Docshub and local:
+Example of JSON in Docshub and local:
### /api/upload
-Uploads file that needs to be trained, response is json with task id, which can be used to check on tasks progress
+Uploads file that needs to be trained, response is JSON with task ID, which can be used to check on task's progress
HTML example:
```html
@@ -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": {
From 4d5d407655ce7e95ca4a4f02ba6683e41cfef9b7 Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 22:00:46 +0530
Subject: [PATCH 24/77] Update Chatwoot-extension.md
---
docs/pages/Extensions/Chatwoot-extension.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/pages/Extensions/Chatwoot-extension.md b/docs/pages/Extensions/Chatwoot-extension.md
index 4dd5782..e95891a 100644
--- a/docs/pages/Extensions/Chatwoot-extension.md
+++ b/docs/pages/Extensions/Chatwoot-extension.md
@@ -13,7 +13,7 @@ chatwoot_token=
5. Start with `flask run` command.
-If you want for bot to stop responding to questions for a specific user or session just add label `human-requested` in your conversation.
+If you want for bot to stop responding to questions for a specific user or session, just add a label `human-requested` in your conversation.
### Optional (extra validation)
@@ -26,4 +26,4 @@ account_id=(optional) 1
assignee_id=(optional) 1
```
-Those are chatwoot values and will allow you to check if you are responding to correct widget and responding to questions assigned to specific user.
\ No newline at end of file
+Those are chatwoot values and will allow you to check if you are responding to correct widget and responding to questions assigned to specific user.
From dc85f93423aaba0a3b104a5c2a27fdc5a4bc9a74 Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 22:02:10 +0530
Subject: [PATCH 25/77] Update react-widget.md
---
docs/pages/Extensions/react-widget.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/pages/Extensions/react-widget.md b/docs/pages/Extensions/react-widget.md
index be4d6bd..1cc1132 100644
--- a/docs/pages/Extensions/react-widget.md
+++ b/docs/pages/Extensions/react-widget.md
@@ -4,7 +4,7 @@
Got to your project and install a new dependency: `npm install docsgpt`.
### Usage
-Go to your project and in the file where you want to use the widget import it:
+Go to your project and in the file where you want to use the widget, import it:
```js
import { DocsGPTWidget } from "docsgpt";
import "docsgpt/dist/style.css";
@@ -14,12 +14,12 @@ import "docsgpt/dist/style.css";
Then you can use it like this: ``
DocsGPTWidget takes 3 props:
-- `apiHost` β url of your DocsGPT API.
-- `selectDocs` β documentation that you want to use for your widget (eg. `default` or `local/docs1.zip`).
-- `apiKey` β usually its empty.
+- `apiHost` β URL of your DocsGPT API.
+- `selectDocs` β documentation that you want to use for your widget (e.g. `default` or `local/docs1.zip`).
+- `apiKey` β usually it's empty.
### How to use DocsGPTWidget with [Nextra](https://nextra.site/) (Next.js + MDX)
-Install you widget as described above and then go to your `pages/` folder and create a new file `_app.js` with the following content:
+Install your widget as described above and then go to your `pages/` folder and create a new file `_app.js` with the following content:
```js
import { DocsGPTWidget } from "docsgpt";
import "docsgpt/dist/style.css";
From 31e0dfef76d5f713d03a24d573509f0cdf1cf30f Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 22:03:18 +0530
Subject: [PATCH 26/77] 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 1d3a7d4..19dcdef 100644
--- a/docs/pages/Guides/Customising-prompts.md
+++ b/docs/pages/Guides/Customising-prompts.md
@@ -1,4 +1,4 @@
-## To customize a main prompt navigate to `/application/prompt/combine_prompt.txt`
+## To customize a main prompt, navigate to `/application/prompt/combine_prompt.txt`
You can try editing it to see how the model responses.
From 64cecb4931ed903be521336643c5f80b08114793 Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 22:07:00 +0530
Subject: [PATCH 27/77] Update How-to-train-on-other-documentation.md
---
.../Guides/How-to-train-on-other-documentation.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/pages/Guides/How-to-train-on-other-documentation.md b/docs/pages/Guides/How-to-train-on-other-documentation.md
index 9f4e503..aef6f00 100644
--- a/docs/pages/Guides/How-to-train-on-other-documentation.md
+++ b/docs/pages/Guides/How-to-train-on-other-documentation.md
@@ -5,18 +5,18 @@ This AI can use any documentation, but first it needs to be prepared for similar
Start by going to `/scripts/` folder.
-If you open this file you will see that it uses RST files from the folder to create a `index.faiss` and `index.pkl`.
+If you open this file, you will see that it uses RST files from the folder to create a `index.faiss` and `index.pkl`.
-It currently uses OPEN_AI to create vector store, so make sure your documentation is not too big. Pandas cost me around 3-4$.
+It currently uses OPEN_AI to create the vector store, so make sure your documentation is not too big. Pandas cost me around $3-$4.
-You can usually find documentation on github in `docs/` folder for most open-source projects.
+You can usually find documentation on Github in `docs/` folder for most open-source projects.
### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory
Name it `inputs/`
Put all your .rst/.md files in there
The search is recursive, so you don't need to flatten them
-If there are no .rst/.md files just convert whatever you find to txt and feed it. (don't forget to change the extension in script)
+If there are no .rst/.md files just convert whatever you find to .txt and feed it. (don't forget to change the extension in script)
### 2. Create .env file in `scripts/` folder
And write your OpenAI API key inside
@@ -32,7 +32,7 @@ It will tell you how much it will cost
### 5. Run web app
-Once you run it will use new context that is relevant to your documentation
+Once you run it will use new context that is relevant to your documentation
Make sure you select default in the dropdown in the UI
## Customization
@@ -41,7 +41,7 @@ You can learn more about options while running ingest.py by running:
`python ingest.py --help`
| Options | |
|:--------------------------------:|:------------------------------------------------------------------------------------------------------------------------------:|
-| **ingest** | Runs 'ingest' function converting documentation to Faiss plus Index format |
+| **ingest** | Runs 'ingest' function, converting documentation to Faiss plus Index format |
| --dir TEXT | List of paths to directory for index creation. E.g. --dir inputs --dir inputs2 [default: inputs] |
| --file TEXT | File paths to use (Optional; overrides directory) E.g. --files inputs/1.md --files inputs/2.md |
| --recursive / --no-recursive | Whether to recursively search in subdirectories [default: recursive] |
@@ -56,4 +56,4 @@ You can learn more about options while running ingest.py by running:
| | |
| **convert** | Creates documentation in .md format from source code |
| --dir TEXT | Path to a directory with source code. E.g. --dir inputs [default: inputs] |
-| --formats TEXT | Source code language from which to create documentation. Supports py, js and java. E.g. --formats py [default: py] |
\ No newline at end of file
+| --formats TEXT | Source code language from which to create documentation. Supports py, js and java. E.g. --formats py [default: py] |
From 706e6c01aaa6397c09d6e29f957a6b5b4c348eb5 Mon Sep 17 00:00:00 2001
From: Suryansh <58465650+drk1rd@users.noreply.github.com>
Date: Sun, 8 Oct 2023 22:08:18 +0530
Subject: [PATCH 28/77] Update How-to-use-different-LLM.md
---
docs/pages/Guides/How-to-use-different-LLM.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/pages/Guides/How-to-use-different-LLM.md b/docs/pages/Guides/How-to-use-different-LLM.md
index aa5815f..c0245a1 100644
--- a/docs/pages/Guides/How-to-use-different-LLM.md
+++ b/docs/pages/Guides/How-to-use-different-LLM.md
@@ -1,4 +1,4 @@
-Fortunately there are many providers for LLM's and some of them can even be ran locally
+Fortunately, there are many providers for LLM's and some of them can even be run locally
There are two models used in the app:
1. Embeddings.
@@ -29,4 +29,4 @@ That's it!
### Hosting everything locally and privately (for using our optimised open-source models)
If you are working with important data and don't want anything to leave your premises.
-Make sure you set `SELF_HOSTED_MODEL` as true in you `.env` variable and for your `LLM_NAME` you can use anything that's on Hugging Face.
+Make sure you set `SELF_HOSTED_MODEL` as true in your `.env` variable and for your `LLM_NAME` you can use anything that's on Hugging Face.
From 5c9d11861efb41c2a1f07f98ddfbd62c7579969b Mon Sep 17 00:00:00 2001
From: staticGuru
Date: Sun, 8 Oct 2023 22:08:19 +0530
Subject: [PATCH 29/77] add the coversation tile in the chat section
---
frontend/src/Navigation.tsx | 51 ++++++++++++-------------------------
1 file changed, 16 insertions(+), 35 deletions(-)
diff --git a/frontend/src/Navigation.tsx b/frontend/src/Navigation.tsx
index e6c5bb6..4c5aac3 100644
--- a/frontend/src/Navigation.tsx
+++ b/frontend/src/Navigation.tsx
@@ -32,6 +32,7 @@ import { useMediaQuery, useOutsideAlerter } from './hooks';
import Upload from './upload/Upload';
import { Doc, getConversations } from './preferences/preferenceApi';
import SelectDocsModal from './preferences/SelectDocsModal';
+import ConversationTile from './conversation/ConversationTile';
interface NavigationProps {
navOpen: boolean;
@@ -126,6 +127,10 @@ export default function Navigation({ navOpen, setNavOpen }: NavigationProps) {
);
});
};
+
+ function updateConversationName(updatedConversation: object) {
+ console.log(updatedConversation);
+ }
useOutsideAlerter(
navRef,
() => {
@@ -210,41 +215,17 @@ export default function Navigation({ navOpen, setNavOpen }: NavigationProps) {
setIsDocsListOpen(!isDocsListOpen)}
>
{selectedDocs && (
From cdad083d7fec09ca77a2a0d7655971c3b4c60a25 Mon Sep 17 00:00:00 2001
From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com>
Date: Mon, 9 Oct 2023 01:21:36 +0530
Subject: [PATCH 38/77] Update CONTRIBUTING.md
---
CONTRIBUTING.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 188a90d..3e96980 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Welcome to DocsGPT Contributing Guidelines
-Thank you for choosing to contribute to DocsGPT! We greatly appreciate your help!
+Thank you for choosing to contribute to DocsGPT! We are all very grateful!
### [π Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! π](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md)
@@ -8,7 +8,7 @@ Thank you for choosing to contribute to DocsGPT! We greatly appreciate your help
π£ Discussions - Engage in conversations, start new topics, or help answer questions.
-π Issues - This is where we keep track of tasks. It could be bug,fixes or suggestions for new features.
+π Issues - This is where we keep track of tasks. It could be bugs,fixes or suggestions for new features.
π οΈ Pull requests - Suggest changes to our repository, either by working on existing issues or adding new features.
From 3197c356e9e9c5cd4ee0c27177e73cf1a6401637 Mon Sep 17 00:00:00 2001
From: ManishMadan2882
Date: Mon, 9 Oct 2023 02:36:48 +0530
Subject: [PATCH 39/77] UI corrections
---
frontend/src/assets/checkmark.svg | 3 ++
frontend/src/assets/copy.svg | 2 +-
.../src/conversation/ConversationBubble.tsx | 32 ++++++++++++++++---
3 files changed, 32 insertions(+), 5 deletions(-)
create mode 100644 frontend/src/assets/checkmark.svg
diff --git a/frontend/src/assets/checkmark.svg b/frontend/src/assets/checkmark.svg
new file mode 100644
index 0000000..682c29d
--- /dev/null
+++ b/frontend/src/assets/checkmark.svg
@@ -0,0 +1,3 @@
+
diff --git a/frontend/src/assets/copy.svg b/frontend/src/assets/copy.svg
index d0da885..846d285 100644
--- a/frontend/src/assets/copy.svg
+++ b/frontend/src/assets/copy.svg
@@ -1,3 +1,3 @@
-