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.

Sign up for GitHub

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

Jump to bottom

update README.md #95

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

update README.md #95

wants to merge 8 commits into from

Conversation

ismaelfaro
Copy link
Contributor

@ismaelfaro ismaelfaro commented Oct 16, 2024 •
edited
Loading

Which issue(s) does this pull-request address?

Adding some details to the README

Description

Adding some details to the readme:

  • current status version [Alpha]
  • alt to the images to improve the accessibility
  • extra information about the LLM models supported
  • reorganize the example and installation comments.
  • adding Examples/README.md

Checklist

  • I have read the contributor guide
  • Linting passes: yarn lint or yarn lint:fix
  • Formatting is applied: yarn format or yarn format:fix
  • Unit tests pass: yarn test:unit
  • E2E tests pass: yarn test:e2e
  • Tests are included
  • Documentation is changed or added
  • Commit messages and PR title follow conventional commits

@Tomas2D Tomas2D self-requested a review October 16, 2024 06:31
ismaelfaro and others added 5 commits October 17, 2024 02:03
@ismaelfaro
Agent for document
f548a90 
initial version
@ismaelfaro
fix style
5cbc722 
Signed-off-by: Ismael Faro <Ismael.Faro1@ibm.com>
@ismaelfaro
Merge branch 'main' into docs_review
c7062ae
@ismaelfaro
fix style README.md
c0ded68 
Signed-off-by: Ismael Faro <Ismael.Faro1@ibm.com>
@ismaelfaro
remove example agent documenation files
19aa3d5 
Signed-off-by: ismael.faro1@ibm.com <Ismael.Faro1@ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Tomas2D Tomas2D Awaiting requested review from Tomas2D

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ismaelfaro