docs: remove meta tools implementation details from README #138
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
Remove reference to "Orama's BM25 algorithm" from the Meta Tools section to keep documentation focused on user-facing functionality rather than internal implementation details. This change: - Removes mention of specific algorithms (BM25, Orama) - Keeps the focus on what users can do (discover and execute tools) - Aligns with the documentation in agents/typescript/meta-tools.mdx - Maintains consistency with SDK documentation standards Users don't need to know about the underlying search algorithm to effectively use meta tools. The implementation details can change over time without affecting the user-facing API.
commit: |
There was a problem hiding this comment.
Pull Request Overview
This PR removes internal implementation details from the Meta Tools section in the README, making the documentation more user-focused and maintainable.
- Removed specific references to Orama and BM25 algorithm from the Meta Tools documentation
- Maintains focus on user-facing functionality (tool discovery and execution capabilities)
- Aligns with documentation best practices by avoiding implementation details that may change
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Related: ENG-11260
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.
Removes implementation details (BM25 algorithm references) from the Meta Tools README section.
Users don't need to know about internal search algorithms to use meta tools effectively. This keeps the README focused on user-facing functionality and aligns with our documentation site.