-
Notifications
You must be signed in to change notification settings - Fork 49
Open
Labels
enhancementNew feature or requestNew feature or request
Description
PROBLEM
We have made some changes to the code base without updating the docs. This is especially problematic because new people that try to contribute don't have access to the most up to date info or clarity around what needs to be done.
SOLUTION
Here is a a list of tasks to be done:
- Add multi-agent class diagram to make the structure of the code base more visually accessible
- In multi-agent class diagram, or a similar one, clarify, ideally visually, what areas we are looking for contributions more actively
- Add information about different types of entities (eg. agents, tools, actions, etc) to ensure people understand where a new type of addition would go
- Structure the docs similar to agentverse or similar repos
- Add a page that articulates the "differentiated utility" of sherpa ideally along with some sample use cases
ALTERNATIVES
n/a
OUTCOME
the docs should be more understandbale for new members of the open source community
ADDITIONAL INFO
n/a
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request