Skip to content

docs: refresh README + website stats after #186/#187/#188/#189#190

Merged
rohitg00 merged 1 commit intomainfrom
docs/readme-website-v0.9.1-refresh
Apr 22, 2026
Merged

docs: refresh README + website stats after #186/#187/#188/#189#190
rohitg00 merged 1 commit intomainfrom
docs/readme-website-v0.9.1-refresh

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented Apr 22, 2026

Summary

Bring README + site stats in line with what actually shipped in the last wave of PRs.

Verification

Summary by CodeRabbit

  • Documentation

    • Updated configuration documentation with new environment variable options for proxies and model setup.
    • Clarified default settings; Claude integration is now opt-in.
  • Chores

    • Test coverage increased to 827 tests passing.
    • Added 6 new tools and 7 new REST endpoints.
  • Bug Fixes

    • Resolved a stability issue by making Claude integration opt-in rather than automatic.

- 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).
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agentmemory Ready Ready Preview, Comment Apr 22, 2026 3:20pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

📝 Walkthrough

Walkthrough

README 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

Cohort / File(s) Summary
Documentation & Configuration
README.md
Updated test count badge (654→827), changed default LLM provider to No-op (Claude now opt-in via AGENTMEMORY_ALLOW_AGENT_SDK=true), added documentation for Anthropic/OpenAI proxy and embedding environment variables, noted historical Stop-hook recursion issue.
Build Metadata
website/lib/generated-meta.json
Incremented tool and endpoint counts (mcpTools: 45→51, restEndpoints: 112→119, testsPassing: 819→848), refreshed generation timestamp.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #180: Manages the generated-meta.json build-time metadata file that is being updated with new numeric counters.
  • PR #5: Modifies README documentation and environment variable guidance for LLM provider configuration and defaults.

Poem

🐰✨ The defaults shift like clouds at dawn,
No-op reigns where Claude once shone,
Opt-in whispers when you need to call,
Tests pass by the hundreds—848 in all! 🏃‍♂️💨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly relates to the main changeset: updating documentation (README and website stats) with references to the specific PRs (#186-189) that triggered these updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-website-v0.9.1-refresh

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 50723e1 and b31a264.

⛔ Files ignored due to path filters (2)
  • assets/tags/light/stat-tests.svg is excluded by !**/*.svg
  • assets/tags/stat-tests.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • README.md
  • website/lib/generated-meta.json

Comment thread README.md
Comment on lines +782 to +787
| **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. |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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).

@rohitg00 rohitg00 merged commit baa5fec into main Apr 22, 2026
5 checks passed
@rohitg00 rohitg00 deleted the docs/readme-website-v0.9.1-refresh branch April 22, 2026 15:23
@rohitg00 rohitg00 mentioned this pull request Apr 22, 2026
rohitg00 added a commit that referenced this pull request Apr 22, 2026
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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant