Improve README and add comprehensive test suite#26
Merged
Conversation
- Restructured README to be more informative and concise - Added quicklinks section for easy navigation - Replaced basic quick start with compelling memory self-correction example - Added Core Concepts section explaining MemGPT foundations - Added missing major features: Sleep-time agents, Agent File import/export, MCP Tools, Filesystem, Long-running agents with resumable streaming - Added Message Types section with discriminated union handling - Fixed API signature inconsistencies in code examples - Improved Contributing section with correct social links - Created comprehensive test suite covering all README examples (12 test files) - Added run_all.sh and run_all.py scripts to execute all tests
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
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.
Overview
This PR significantly improves the README documentation and adds a comprehensive test suite to ensure all code examples work correctly.
README Improvements
.afformat)block_labelparameter,modifyinstead ofupdate,retrievemethod)Test Suite
Created comprehensive test suite covering all README examples:
01_quick_start.pythrough12_custom_http_client.py)run_all.shscript to execute all testsrun_all.pyprogrammatic test runner