Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch 2 #675

Merged
merged 5 commits into from
Oct 25, 2023
Merged

Patch 2 #675

merged 5 commits into from
Oct 25, 2023

Conversation

krishvsoni
Copy link
Contributor

  • What kind of change does this PR introduce? - docs update -

  • Why was this change needed? (You can also link to an open issue here

  • ) Already yaml file of docker is given but it in quick start we need to give Docker official url for downloading according to user device. It will help to setup the docker will also save the time

  • Other information: - image

@vercel
Copy link

vercel bot commented Oct 23, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-gpt ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2023 10:57am
nextra-docsgpt ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2023 10:57am

@vercel
Copy link

vercel bot commented Oct 23, 2023

@krishvsoni is attempting to deploy a commit to the Arc53 Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions bot added the repo label Oct 23, 2023
@krishvsoni krishvsoni mentioned this pull request Oct 23, 2023
@codecov
Copy link

codecov bot commented Oct 23, 2023

Codecov Report

Merging #675 (130a6b6) into main (7bd7d66) will not change coverage.
Report is 51 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #675   +/-   ##
=======================================
  Coverage   18.26%   18.26%           
=======================================
  Files          59       59           
  Lines        2743     2743           
=======================================
  Hits          501      501           
  Misses       2242     2242           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@dartpain dartpain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the changes

README.md Outdated
@@ -7,9 +7,9 @@
</p>

<p align="left">
<strong><a href="https://docsgpt.arc53.com/">DocsGPT</a></strong> is a cutting-edge open-source solution that streamlines the process of finding information in the project documentation. With its integration of the powerful <strong>GPT</strong> models, developers can easily ask questions about a project and receive accurate answers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing the link?

README.md Outdated

Say goodbye to time-consuming manual searches, and let <strong><a href="https://docsgpt.arc53.com/">DocsGPT</a></strong> 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again

README.md Outdated

We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.

- [Book Demo 👋](https://airtable.com/appdeaL0F1qV8Bl2C/shrrJF1Ll7btCJRbP)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be book demo, and why are lines removed?

README.md Outdated
## Roadmap

You can find our roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!

## Our Open-Source models optimized for DocsGPT:

| Name | Base Model | Requirements (or similar) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Table was cleaner, why change it?

README.md Outdated
## Features

![Group 9](https://user-images.githubusercontent.com/17906039/220427472-2644cff4-7666-46a5-819f-fc4a521f63c7.png)

## Useful links

- 🔍🔥 [Live preview](https://docsgpt.arc53.com/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are emojis removed?

README.md Outdated
@@ -87,30 +89,26 @@ 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](https://platform.openai.com/account/api-keys) and `VITE_API_STREAMING` to true or false, depending on whether you want streaming answers or not.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait I fix

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a min

@krishvsoni
Copy link
Contributor Author

Done✔️

@dartpain
Copy link
Contributor

Can you please link it to instruction on how to install docker not just a documentation website. Thank you!

@krishvsoni
Copy link
Contributor Author

I added install docker url

@krishvsoni
Copy link
Contributor Author

Hello, As we had conflicts before in the branch so I had resolved it, and as mentioned about downloading docker I had put the url in the Docker keyword in the README file.

@dartpain dartpain merged commit 43f6565 into arc53:main Oct 25, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants