search

autogenhub / autogen

A programming framework for agentic AI. Discord: https://discord.gg/pAbnFJrkgZ
https://autogenhub.github.io/autogen/
Apache License 2.0
119 stars 23 forks source link

[Feature Request]: Website Documentation Improvement #15

Open yiranwu0 opened 3 months ago

yiranwu0 commented 3 months ago

Is your feature request related to a problem? Please describe.

Creating a roadmap to put together an organized and clear documentation in the website: https://autogen-ai.github.io/autogen/

The documents can be improved from two perspectives:

  1. Organization: categorization of content, proper names and cross references.
  2. Clarity: Reduce redundant and repetitive content.

Collective thoughts

Feel free to reply with any suggestions/thoughts to improve the documents here!

  1. tutorial - conversation pattern: this section is too long. It is better to have a light-weight version in the tutorial, and put more details in User Guide.

(Add more thoughts here or comment below)

marklysze commented 3 months ago

I'm not sure the best place to put it, but it would be useful to have a guide/table that has on the left a set of things you're trying to achieve and on the right is guidance on what to create and documentation links.

E.g. I want to... Guidance Links
Use a specific agent sequence in a group chat Finite State Machine [link 1]() [link 2]()
Get an agent to call a function Function/Tool calling [link 1]() [link 2]()
Use local LLMs See Using Non-OpenAI Models in the documentation [link 1]()
Have an agent search the web Notebook example... [link 1]()

etc.