Conversation
sairin1202
commented
Jan 6, 2026
sairin1202
commented
- fix readme bug
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation to the README by completing the self-hosted deployment section. The changes expand the README from 98 lines to 355 lines, adding installation instructions, API documentation, usage examples, and community information.
Key Changes:
- Added complete self-hosted installation and basic example sections with both in-memory and PostgreSQL options
- Documented core APIs (
memorize()andretrieve()) with detailed explanations of RAG vs LLM retrieval strategies - Added three use case examples, performance benchmarks, ecosystem overview, partners section, and community links
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## 🌍 Community | ||
|
|
||
| - **GitHub Issues**: [Report bugs & request features](NevaMind-AI/memU) |
There was a problem hiding this comment.
The GitHub Issues link appears incomplete or malformed. It shows "NevaMind-AI/memU" but should be a full URL like https://github.com/NevaMind-AI/memU/issues to properly link to the issues page.
| - **GitHub Issues**: [Report bugs & request features](NevaMind-AI/memU) | |
| - **GitHub Issues**: [Report bugs & request features](https://github.com/NevaMind-AI/memU/issues) |
| --- | ||
|
|
There was a problem hiding this comment.
There are duplicate horizontal dividers (---) on consecutive lines. Line 316 and 317 both contain dividers, which is redundant. One of these should be removed to maintain proper document structure.
| --- |
| | Repository | Description | Use Case | | ||
| |------------|-------------|----------| | ||
| | **[memU](https://github.com/NevaMind-AI/memU)** | Core algorithm engine | Embed AI memory into your product | | ||
| | **[memU-server](GitHub - NevaMind-AI/memU-server: backend wrapper for memU)** | Backend service with CRUD, user system, RBAC | Self-host a memory backend | |
There was a problem hiding this comment.
The link format for the memU-server repository appears to be incorrect. It shows "GitHub - NevaMind-AI/memU-server: backend wrapper for memU" which looks like raw link text rather than a properly formatted URL. This should be either a proper markdown link like [memU-server](https://github.com/NevaMind-AI/memU-server) or just the URL.
| | **[memU-server](GitHub - NevaMind-AI/memU-server: backend wrapper for memU)** | Backend service with CRUD, user system, RBAC | Self-host a memory backend | | |
| | **[memU-server](https://github.com/NevaMind-AI/memU-server)** | Backend service with CRUD, user system, RBAC | Self-host a memory backend | |
| <div align="center"> | ||
|
|
||
| <a href="https://github.com/TEN-framework/ten-framework"><img src="https://avatars.githubusercontent.com/u/113095513?s=200&v=4" alt="Ten" height="40" style="margin: 10px;"></a> | ||
| <a href="GitHub - openagents-org/openagents: OpenAgents - AI Agent Networks for Open Collaboration"><img src="assets/partners/openagents.png" alt="OpenAgents" height="40" style="margin: 10px;"></a> |
There was a problem hiding this comment.
The link format for the OpenAgents repository appears to be incorrect. It shows "GitHub - openagents-org/openagents: OpenAgents - AI Agent Networks for Open Collaboration" which looks like raw link text rather than a properly formatted URL. This should be a proper URL like https://github.com/openagents-org/openagents.
| <a href="GitHub - openagents-org/openagents: OpenAgents - AI Agent Networks for Open Collaboration"><img src="assets/partners/openagents.png" alt="OpenAgents" height="40" style="margin: 10px;"></a> | |
| <a href="https://github.com/openagents-org/openagents"><img src="assets/partners/openagents.png" alt="OpenAgents" height="40" style="margin: 10px;"></a> |
