[README] Add readme functionality #12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Making sure other can use this gem by leaving a comprehensive readme
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation to the LlmEvalRuby gem by replacing the default README template with detailed usage instructions and examples. The documentation covers the gem's core functionality including prompt management, tracing capabilities, and configuration options.
- Replaces placeholder content with comprehensive gem documentation
- Adds detailed usage examples for prompt management and tracing features
- Updates GitHub repository references from placeholder to actual repository
garciaf
commented
Jul 15, 2025
|
|
||
| Or install it yourself as: | ||
|
|
||
| $ gem install llm_eval_ruby |
Member
Author
There was a problem hiding this comment.
Is this gem globally available? Or should we install via git repo?
Contributor
There was a problem hiding this comment.
it is a public gem
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
aleksei-okatiev
approved these changes
Jul 15, 2025
mesmerze
approved these changes
Jul 16, 2025
Contributor
mesmerze
left a comment
mesmerze
left a comment
There was a problem hiding this comment.
lets merge this please 🙏
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Making sure other can use this gem by leaving a comprehensive readme