docs: refresh README + website stats after #186/#187/#188/#189#190
docs: refresh README + website stats after #186/#187/#188/#189#190
Conversation
- README provider table: surface the no-op default and call out the opt-in Claude-subscription fallback with AGENTMEMORY_ALLOW_AGENT_SDK (from #187) instead of listing 'Claude subscription' as the default. - README env block: document OPENAI_BASE_URL / OPENAI_EMBEDDING_MODEL (#186) and OPENAI_EMBEDDING_DIMENSIONS (#189), plus MINIMAX_API_KEY. - Hero stat-tests SVG: 654 -> 827 (both dark and light variants) to match current suite size after recursion guard + idempotent lesson/crystal tests + openai dimension tests landed. - website/lib/generated-meta.json regenerated by website/scripts/gen-meta.mjs (v0.9.1, 51 tools, 12 hooks, 119 endpoints, 848 tests).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughREADME and metadata updates: benchmark badge incremented to 827 tests passing, LLM provider defaults changed from Claude subscription to No-op provider with opt-in fallback, and environment variable documentation expanded for proxy and embedding configurations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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`:
- Around line 782-787: The README contains a contradictory sentence ("No API key
needed if you have a Claude subscription.") that conflicts with the provider
table which documents no-op as the default and requires explicit opt-in for the
Claude agent-sdk via AGENTMEMORY_ALLOW_AGENT_SDK; remove or reword that earlier
sentence so it accurately reflects the table (e.g., delete it or replace with a
brief note that Claude subscription support is opt-in via
AGENTMEMORY_ALLOW_AGENT_SDK and not the default).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 04d66218-a7d2-40d1-8082-98e72167b1b7
⛔ Files ignored due to path filters (2)
assets/tags/light/stat-tests.svgis excluded by!**/*.svgassets/tags/stat-tests.svgis excluded by!**/*.svg
📒 Files selected for processing (2)
README.mdwebsite/lib/generated-meta.json
| | **No-op (default)** | No config needed | LLM-backed compress/summarize is DISABLED. Synthetic BM25 compression + recall still work. See `AGENTMEMORY_ALLOW_AGENT_SDK` below if you used to rely on the Claude-subscription fallback. | | ||
| | Anthropic API | `ANTHROPIC_API_KEY` | Per-token billing | | ||
| | MiniMax | `MINIMAX_API_KEY` | Anthropic-compatible | | ||
| | Gemini | `GEMINI_API_KEY` | Also enables embeddings | | ||
| | OpenRouter | `OPENROUTER_API_KEY` | Any model | | ||
| | Claude subscription fallback | `AGENTMEMORY_ALLOW_AGENT_SDK=true` | Opt-in only. Spawns `@anthropic-ai/claude-agent-sdk` sessions — used to cause unbounded Stop-hook recursion (#149 follow-up) so it is no longer the default. | |
There was a problem hiding this comment.
Provider section still has a contradictory sentence above this table.
Given this section now correctly documents no-op as default + explicit opt-in for agent-sdk fallback, the earlier sentence at Line 778 (“No API key needed if you have a Claude subscription.”) is misleading and should be updated/removed for consistency.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 782 - 787, The README contains a contradictory
sentence ("No API key needed if you have a Claude subscription.") that conflicts
with the provider table which documents no-op as the default and requires
explicit opt-in for the Claude agent-sdk via AGENTMEMORY_ALLOW_AGENT_SDK; remove
or reword that earlier sentence so it accurately reflects the table (e.g.,
delete it or replace with a brief note that Claude subscription support is
opt-in via AGENTMEMORY_ALLOW_AGENT_SDK and not the default).
Rolls up #186 (OPENAI_BASE_URL / OPENAI_EMBEDDING_MODEL), #187 (Stop-hook recursion 5-layer defense + NoopProvider + AGENTMEMORY_ALLOW_AGENT_SDK opt-in), #188 (viewer empty-tabs + import-jsonl synthetic compression + auto-derived lessons/crystals + richer session detail + audit/replay/frontier shape fixes), #189 (OPENAI_EMBEDDING_DIMENSIONS + model-dimensions table), and #190 (README/website docs refresh). Bumps: package.json, plugin/.claude-plugin/plugin.json, src/version.ts, src/types.ts ExportData.version union, src/functions/export-import.ts supportedVersions, test/export-import.test.ts assertion, and packages/mcp/package.json shim (was stuck at 0.9.0).
Summary
Bring README + site stats in line with what actually shipped in the last wave of PRs.
Claude subscription (default)row was misleading. Moved the subscription path to a separate row withAGENTMEMORY_ALLOW_AGENT_SDK=trueopt-in and a note about the Stop-hook recursion guard.OPENAI_BASE_URL/OPENAI_EMBEDDING_MODEL(from feat: support OPENAI_BASE_URL and OPENAI_EMBEDDING_MODEL for OpenAI-compatible endpoints #186),OPENAI_EMBEDDING_DIMENSIONS+ model-dimension lookup (from fix(embedding): derive OpenAI provider dimensions from model #189), andMINIMAX_API_KEY.assets/tags/stat-tests.svg+assets/tags/light/stat-tests.svgbumped 654 → 827 to match the current suite after recursion-guard tests, content-addressed-id idempotency tests, and openai-dimension tests landed.website/lib/generated-meta.jsonregenerated viawebsite/scripts/gen-meta.mjs: v0.9.1 / 51 tools / 12 hooks / 119 endpoints / 848 tests. The script already runs as aprebuildstep so this is just the checked-in snapshot.Verification
npm run build(root) clean.npm test827 / 827 pass.cd website && npm run buildclean.Provider: noopline and the stderr warning from fix(hooks): break Stop-hook infinite recursion via agent-sdk fallback #187.import-jsonl+ re-import: lesson reinforcements bump on re-import (content-addressed IDs from fix(viewer): repair empty tabs + enrich session detail + auto-derive lessons/crystals on import #188 working).Summary by CodeRabbit
Documentation
Chores
Bug Fixes