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
Make markdown tutorials for ChatAgent
#313
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi. Thank you so much for working on documents and we appreciate your contribution. The document looks clear. Here are Just some advises.
In my opinion, the documents in the get_started
section should introduce the module as simple, stupid as possible. We just write something for new users to quickly understand the basic idea of the module and to get started. The detailed information can be checked in the API docs and the code. Thus, we need more intuitive description with examples in a real productive situation.
4067b48
to
5e7f935
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This tutorials are very valuable as they are. Let's merge them. Later we will rework the tutorials to be more simplistic and less technical.
Description
Add documentation for core class ChatAgent.
Motivation and Context
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax
close #15213
if this solves the issue #15213Types of changes
What types of changes does your code introduce? Put an
x
in all the boxes that apply:Implemented Tasks
Checklist
Go over all the following points, and put an
x
in all the boxes that apply.If you are unsure about any of these, don't hesitate to ask. We are here to help!