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

[OPS] Improve Sherpa Docs #236

Open
5 tasks
amirfz opened this issue Nov 27, 2023 · 1 comment
Open
5 tasks

[OPS] Improve Sherpa Docs #236

amirfz opened this issue Nov 27, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@amirfz
Copy link
Contributor

amirfz commented Nov 27, 2023

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

@amirfz amirfz added the enhancement New feature or request label Nov 27, 2023
@artificialfintelligence
Copy link
Contributor

Would this be the right place to report some broken and/or possibly outdated docs? If so, this page seems to have broken formatting and perhaps more importantly, much of its content seems to be identical to this page.

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

No branches or pull requests

2 participants