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

Improvement: Changes required in the DocsGPT Docs. #962

Closed
6 tasks
shelar1423 opened this issue May 22, 2024 · 0 comments · Fixed by #971
Closed
6 tasks

Improvement: Changes required in the DocsGPT Docs. #962

shelar1423 opened this issue May 22, 2024 · 0 comments · Fixed by #971
Assignees

Comments

@shelar1423
Copy link
Collaborator

  • 1.Only showcase guides for simple local deployment or Kubernetes (The rest can be an external link)

  • 2.Customizing prompts section need to be updated as the current documentation follows the complex way/old way and the improvements have been made to perform this task and the improvements have been made to perform this task. We now have a primary way - UI to upload docs also needs to mention remote uploads too. also users can use cli script to create embeddings.

  • Currently the Customizing prompts section looks like this : https://docs.docsgpt.cloud/Guides/Customising-prompts.

  • but we with the updates in UI we can now perform the same action in easier way by going to:
    Settings->General->Active Prompts->Edit icon

image


  • 3.Training on docs section needs to be updated as the current documentation follows the complex way/old way and the improvements have been made to perform this task and the improvements have been made to perform this task. We now have a primary way - UI to upload docs also needs to mention remote uploads too. also users can use cli script to create embeddings.

Currently the Training on docs section looks like this : https://docs.docsgpt.cloud/Guides/How-to-train-on-other-documentation

but we with the updates in UI we can now perform the same action in easier way by going to:
SideBar->Source Docs->Upload icon

image

image


  • 4.How to use different LLMS's section as the current documentation follows the complex way/old way and the improvements have been made to perform this task.and the improvements have been made to perform this task. We now have a primary way - UI to upload docs also needs to mention remote uploads too. also users can use cli script to create embeddings.

Currently the How to use different LLMS's section looks like this :https://docs.docsgpt.cloud/Guides/How-to-use-different-LLM

but we with the updates in UI we can now perform the same action in easier way by going to:
Chat Screen -> Default LLM->Side Arrow ->Selecting LLM of your choice

image



  • 5.Home section demo video/gif needs to be updated.

  • Currently the Home section demo gif looks like this : https://docs.docsgpt.cloud/
    demov3

  • but there have been UI improvements and addtional feature updates and the home screen looks like this now :

image

  • therefore updated demo video/gif needs to be added.

  • 6.Can have a different section in the structure regarding API's which will consist of all API's related information i.e API usages,API keys etc..

shelar1423 added a commit to shelar1423/DocsGPT that referenced this issue May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant