docs: rewrite README for v0.3.0 — what, why, and agent support#5
docs: rewrite README for v0.3.0 — what, why, and agent support#5
Conversation
- Add "Why agentmemory" section explaining what it provides and comparison table - Add "Supported Agents" section with native hooks, MCP, and REST API paths - Add integration decision matrix for choosing the right approach - Document hybrid search, embedding providers, and progressive disclosure - Document memory evolution, versioning, relationships, and auto-forget - Document project profiles, timeline, export/import - Update all stats (21 functions, 10 MCP tools, 28 endpoints, 144 tests) - Update data model with new KV scopes (relations, profiles, embeddings, bm25) - Update config section with embedding, fallback, and search weight env vars
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME.md underwent comprehensive restructuring: header presentation changed to centered banner; navigation anchors reorganized; introductory narrative reframed around persistent memory architecture; feature sections expanded to include semantic search, memory evolution, and project profiles; integration guidance updated for multiple methods; quick start examples and command references refreshed; and data model architecture expanded with embeddings and memory relationships documentation. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Remove cream strip at bottom, cap width to 720px in README
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
28-40:⚠️ Potential issue | 🟡 MinorAdd language identifiers to fenced code blocks to satisfy lint and improve rendering consistency.
The fences starting at Line 28, Line 201, Line 276, and Line 349 are missing language tags (MD040). Use
textfor flow/pipeline blocks.Suggested diff
-``` +```text Session 1: "Add auth to the API" Agent writes code, runs tests, fixes bugs agentmemory silently captures every tool use Session ends -> observations compressed into structured memory @@ -``` +```text SessionStart hook fires -> mem::context Load recent sessions for this project @@ -``` +```text v1: "Use Express for API routes" v2: "Use Fastify instead of Express for API routes" (supersedes v1) v3: "Use Hono instead of Fastify for Edge API routes" (supersedes v2) @@ -``` +```text Primary provider fails -> Circuit breaker opens (3 failures in 60s) -> Falls back to next provider in FALLBACK_PROVIDERS chain -> 30s cooldown -> half-open -> test call -> recoveryAlso applies to: 201-208, 276-280, 349-354
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 28 - 40, Update the four fenced code blocks by adding the language tag `text` after the opening backticks — specifically change the blocks that begin with "Session 1: \"Add auth to the API\"", "SessionStart hook fires", "v1: \"Use Express for API routes\"", and "Primary provider fails" so each opens with ```text instead of ```, which will satisfy MD040 and ensure consistent rendering.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 74: The sentence "agentmemory works with any agent that supports hooks or
MCP." should be reworded to include REST API support so the contract is
consistent; change that line to e.g. "agentmemory works with any agent that
supports hooks, MCP, or via a REST API." Also update the later paragraph (the
section currently describing REST support at lines ~97-100) to mirror this
wording and explicitly state that agents without hooks/MCP can integrate using
the REST API, ensuring both places use the same phrasing and intent.
---
Outside diff comments:
In `@README.md`:
- Around line 28-40: Update the four fenced code blocks by adding the language
tag `text` after the opening backticks — specifically change the blocks that
begin with "Session 1: \"Add auth to the API\"", "SessionStart hook fires", "v1:
\"Use Express for API routes\"", and "Primary provider fails" so each opens with
```text instead of ```, which will satisfy MD040 and ensure consistent
rendering.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
assets/banner.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
Consistent wording in both the intro line and REST section
* docs: rewrite README for v0.3.0 - Add "Why agentmemory" section explaining what it provides and comparison table - Add "Supported Agents" section with native hooks, MCP, and REST API paths - Add integration decision matrix for choosing the right approach - Document hybrid search, embedding providers, and progressive disclosure - Document memory evolution, versioning, relationships, and auto-forget - Document project profiles, timeline, export/import - Update all stats (21 functions, 10 MCP tools, 28 endpoints, 144 tests) - Update data model with new KV scopes (relations, profiles, embeddings, bm25) - Update config section with embedding, fallback, and search weight env vars * docs: add banner image to README * docs: fix banner crop and size Remove cream strip at bottom, cap width to 720px in README * docs: include REST API in supported agents intro Consistent wording in both the intro line and REST section
1 participant
Summary
Test plan
Summary by CodeRabbit