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]: Write a basic "Getting Started" Guide in the README #29

Closed
alckasoc opened this issue Feb 13, 2024 · 0 comments · Fixed by #31
Closed

[Feature Request]: Write a basic "Getting Started" Guide in the README #29

alckasoc opened this issue Feb 13, 2024 · 0 comments · Fixed by #31
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@alckasoc
Copy link
Member

Feature Description

This guide should:

  • concise but clearly showcase this library's uses
  • demonstrate the overall library structure
  • what the library provides and what it doesn't
  • simple use case with defining a module (any module or all; though keep it minimal, this is a getting started guide)
  • simple use case defining an agent (ReAct is a good start)
  • running an agent on sample input

Reason

No response

@alckasoc alckasoc added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Feb 13, 2024
This was linked to pull requests Feb 17, 2024
@alckasoc alckasoc removed a link to a pull request Feb 17, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants