mem0ai
docs: improve QnA pair documentation with examples (#1340)
This commit updates the documentation for the 'qna_pair' data source type to provide clearer guidance to users.
- Added an overview section to explain the purpose of QnA pairs
- Explained the required tuple format with a detailed example
- Included a section on common mistakes and how to fix them
- Provided context on internal storage and error behavior
- Added related links for easier navigation
These changes aim to address confusion around QnA formatting, as described in issue #1340, and help reduce errors when using the add() method with QnA pairs.
Description
This PR improves the QnA pair documentation by expanding details around proper usage, error handling, and formatting expectations. It provides clearer examples, highlights common mistakes, and offers better guidance to help new users integrate QnA pairs successfully into the app.
Fixes #1340
Type of change
Please delete options that are not relevant.
- [ ] 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)
- [ ] Refactor (does not change functionality, e.g. code style improvements, linting)
- [x] Documentation update
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
- [x] Markdown preview in GitHub and VS Code
- [x] Confirmed rendering and formatting of examples and sections
- [x] Verified clarity and technical accuracy of usage instructions
Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works (N/A for documentation)
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [x] I have checked my code and corrected any misspellings
Maintainer Checklist
- [x] closes #1340
- [x] Made sure Checks passed
