DB-GPT icon indicating copy to clipboard operation
DB-GPT copied to clipboard

[Doc]: how can we better document how each element of the db-gpt architecture works?

Open valdesguefa opened this issue 1 year ago • 3 comments

valdesguefa avatar Jun 20 '23 17:06 valdesguefa

We released some documentation, of course, but don't cover specific details yet. We are also doing our best to supplement.

address: https://db-gpt.readthedocs.io/en/latest/

csunny avatar Jun 21 '23 03:06 csunny

@csunny are there any endpoints that can be accessed via an api?

valdesguefa avatar Jun 21 '23 11:06 valdesguefa

No, we have not currently. Our project architecture lacks complete layering at the API level. However, in the next version, we plan to define the API of the initial version and ensure proper project layering.

In our plan,we will do follow things

  1. about the knownledge base we will provide a backend management system.
  2. and refactor chat ui.
  3. about api, we will provide the necessary openapi.

We welcome any additional suggestions to enhance the project. Thank you.

csunny avatar Jun 21 '23 13:06 csunny

@valdesguefa Hi, we updated our documents, maybe it will help you.

csunny avatar Nov 27 '23 16:11 csunny

The latest documents.

csunny avatar Dec 05 '23 11:12 csunny