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

Docs/add more documentation #36

Merged
merged 3 commits into from
Jan 28, 2025

Conversation

anandan947
Copy link
Contributor

@anandan947 anandan947 commented Jan 20, 2025

Description

This PR adds more documentation to the Docs.

  • How to build a simple chatbot with Legion
  • How tools work in Legion

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Code cleanup or refactor

Implementation Details

This contains the following addition to the Docs -

  • Adds a chatbot example since many that is likely to be many people's first use-case that they want to try out.
  • Adds explanation of what tools do and how they work
  • Adds explanation of how to do parameter injection with tools.
  • Adds loading the .env file for setting the API keys in the quickstart example.

Testing

  • All existing tests pass
  • Added new tests for the changes

Documentation Changes

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link
Contributor

@Zain-Imdad Zain-Imdad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@Zain-Imdad Zain-Imdad merged commit 63ec40c into LLMP-io:main Jan 28, 2025
1 check failed
@anandan947 anandan947 deleted the docs/add-more-documentation branch January 30, 2025 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants