docs: update readme files in docs/examples#1228
Open
akihikokuroda wants to merge 3 commits into
Open
Conversation
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
akihikokuroda
changed the title
github-actions
Bot
added
the
documentation
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
psschwei
reviewed
Jun 9, 2026
|
|
||
| ## Prerequisites | ||
|
|
||
| These examples use async/await and require Python 3.7+. Most examples also need a running Ollama instance: |
Member
There was a problem hiding this comment.
I think Mellea requires python 3.10+ or maybe even 3.11+
Comment on lines
+94
to
+97
| ```bash | ||
| uv run context_attribution.py | ||
| ``` | ||
| Demonstrates identifying which context sentences influenced the response. |
Member
There was a problem hiding this comment.
This isn't actually using a RAG intrinsic
Suggested change
| ```bash | |
| uv run context_attribution.py | |
| ``` | |
| Demonstrates identifying which context sentences influenced the response. |
Member
There was a problem hiding this comment.
plugin_scoped.py isn't documented... any particular reason?
Member
Author
There was a problem hiding this comment.
No, just missed it.
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
psschwei
approved these changes
Jun 10, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Pull Request
Issue
Fixes #
Description
Updating README.md files under docs/examples and subdirectories. Some directories were missing README.md file or not included in the main README.md file.
Testing
Attribution
Adding a new component, requirement, sampling strategy, or tool?
If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.
NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.