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

[Feature Request]: Website Documentation Improvement #15

Open
yiranwu0 opened this issue Aug 26, 2024 · 1 comment
Open

[Feature Request]: Website Documentation Improvement #15

yiranwu0 opened this issue Aug 26, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request roadmap Work planned

Comments

@yiranwu0
Copy link
Collaborator

yiranwu0 commented Aug 26, 2024

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)

@yiranwu0 yiranwu0 added enhancement New feature or request roadmap Work planned labels Aug 26, 2024
@yiranwu0 yiranwu0 self-assigned this Aug 26, 2024
@marklysze
Copy link
Collaborator

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.

odoochain pushed a commit to odoochain/autogen that referenced this issue Nov 10, 2024
* update sk all around - memory

* enable all roslyn rules

* remove githubjwt dependency

* add kernel-memory
odoochain pushed a commit to odoochain/autogen that referenced this issue Nov 10, 2024
* Add initial docs site

* add ci and readme

* Update checks.yml

* Update conf.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request roadmap Work planned
Projects
None yet
Development

No branches or pull requests

3 participants
@yiranwu0 @marklysze and others