[Roadmap] Documentation and Training

[jackgerrits]

Tip

Want to get involved?

We'd love it if you did! Please get in contact with the people assigned to this issue, or leave a comment. See general contributing advice here too.

This roadmap is for our documentation effort. Point of Contact: @ekzhu @jackgerrits

There are two types of tasks: content tasks, and utility tasks.

Content Tasks

Preview Give feedback

1. Azure Sample: AutoGen Tutorial: https://github.com/Azure-Samples/autogen-tutorial
2. User Guide: Group Chat [Documentation] Creating a new category for "GroupChat" #2243
3. User Guide: Multi-Modal [Documentation] create topic to cover multimodal features #2142
4. User Guide: Teachability
5. User Guide: RAG
6. User Guide: Streaming
7. User Guide: Logging and Observability [Documentation] Create topic page for logging and observability. #2146
8. User Guide: System Design [Feature Request]: Documentation about system design #1351
9. User Guide: Complex Workflows Better documentation of complex workflow #2015
10. Notebooks: Simply config_list creation in notebooks and fix examples where llm configs are shared #2139
11. Gallery: Replaced default images, invite community contributions
12. Notebooks: audit notebooks for consistency of installation/config instructions
13. Use latest APIs for tool use, code execution and cache in topic pages #2071
    code-execution documentation tool-usage +3
14. Need a user guide page in website/docs/topics/ to document the OAI Assistant. #2465
    documentation openai-assistant +2

Utility Tasks

Preview Give feedback

1. Notebook testing in CI
2. Notebook gallery browsing page with interactive views.
3. [Feature Request]: Render example notebooks in documentation site #1339
   1 of 2
   0.2 documentation feature +3
   
4. [Issue]: Enhance notebook contributing guide #2032
   0.2 documentation needs-triage +3
5. [Issue]: Improve consistency of doc strings across modules #2048
   dev documentation good first issue +3
   
6. Align on docstring style and lint with ruff
7. Enable testing of more notebooks
8. Better categorization of notebooks page

Discord channel for discussion around documentation

[jackgerrits]

@davorrunje are you interested in working on any of the content around tool use?

[rickyloynd-microsoft]

Thanks Jack. I can cover documentation for Capabilities and Teachability. Ricky

[davorrunje]

@davorrunje are you interested in working on any of the content around tool use?

@jackgerrits yes, I am. One thing: I have a fiver and will be offline for a few days. Some kindergarten virus is in the house 🤷‍♂️

[jackgerrits]

@davorrunje are you interested in working on any of the content around tool use?

@jackgerrits yes, I am. One thing: I have a fiver and will be offline for a few days. Some kindergarten virus is in the house 🤷‍♂️

No worries at all! I hope you feel better soon

[davorrunje]

@davorrunje are you interested in working on any of the content around tool use?

@jackgerrits yes, I am. One thing: I have a fiver and will be offline for a few days. Some kindergarten virus is in the house 🤷‍♂️

No worries at all! I hope you feel better soon

I am back. What's the plan? How to start with this?

[jackgerrits]

The idea is to create "topic docs", so the purpose is to explain more than to provide an example is as the case with notebooks. You can see an example of the style here.

For tool use one idea is to have a general page that outlines the concept of tool use and enumerates the different possible places in autogen that this is relevant (function map, web surfer agent, code execution etc). I am open to ideas about what you think is best for how to present this info

[gagb]

@jackgerrits @ekzhu should we putting logging on the agenda?

[jackgerrits]

Yeah definitely, we should add topics when we think of them. Please feel free to add logging where it makes sense

[nitya]

Hi folks - had created this markmap to help me navigate Autogen in a more cohesive way - and was encouraged to share feedback here so wanted to weigh in on the thread.

This was how I saw the docs being organized in my head, from the perspective of a developer journey where they need to go from core concepts to a quickstart to understanding tools for productivity before getting recipes for doing various specific tasks.

Would love to contribute feedback and/or content to shape the docs if you find it helpful.

I've also found this a useful way to identify gaps in the journey and to find out areas that developers are likely not aware of because the relevant documentation is buried elswwhere (e.g., in a blog post or in the github subfolder readme) - this helped me frame the big picture before diving in.

[rysweet]

@gagb @jackgerrits @ekzhu - how much of this is still needed?

[jackgerrits]

I think this can be closed as it is either stale or captured in new issues.