Skip to content

Docs cleanup for open-source launch#1

Merged
shenli merged 7 commits intomainfrom
docs-cleanup
Mar 17, 2026
Merged

Docs cleanup for open-source launch#1
shenli merged 7 commits intomainfrom
docs-cleanup

Conversation

@lightcone0
Copy link
Copy Markdown
Contributor

Summary

  • Rewrite README with problem statement, architecture diagram, comparison table (vs Mem0/Zep/Letta), collapsible FAQ, and focused quick start snippets
  • Add CONTRIBUTING.md with dev setup, testing, project structure, and contribution workflow
  • Clean up CLAUDE.md for open-source contributors (remove local Homebrew paths)
  • Remove internal docs: product design doc, context-module design doc

Test plan

  • Verify README renders correctly on GitHub (badges, architecture diagram, collapsible FAQ)
  • Confirm no personal references remain (lishen, Li Shen, shenli)
  • Review comparison table for accuracy

🤖 Generated with Claude Code

lightcone0 and others added 7 commits March 16, 2026 18:37
- Rewrite README with problem statement, architecture diagram, comparison
  table, FAQ section, and polished quick start
- Add CONTRIBUTING.md with dev setup and guidelines
- Clean up CLAUDE.md for open-source contributors (remove local paths)
- Remove internal docs (product design, context-module design doc)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
README now leads with the problem, covers install/features/CLI/inspector
concisely. Detailed API reference, embedding setup, sub-agent internals,
migration, and manual setup moved to docs/ directory.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- OpenClaw: rewrite "What You Get" as user outcomes instead of
  implementation details, rename "Inspect Your Memory" to "Inspector"
- Main: add missing import/backend setup to first Quick Start snippet

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Lead with the problem (CLAUDE.md is static, doesn't learn)
- Outcome-focused "What You Get"
- Remove 120-line competitive analysis with stale star counts
- Add Inspector and Manage sections
- Keep tools table, scopes, config, superseding example

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Streamline README: cleaner structure, consolidated results tables,
  remove verbose per-feature analysis
- Remove unused suite, metric, and data scripts
- Clean up exports and CLI references

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@shenli shenli merged commit 9308849 into main Mar 17, 2026
@shenli shenli deleted the docs-cleanup branch March 17, 2026 18:00
lightcone0 added a commit that referenced this pull request Mar 20, 2026
Backed by real developer complaints: GitHub Discussion #4845
(persistence is the #1 pain), AI SDK's own memory docs acknowledging
the gap, and the existence of 4+ third-party memory providers.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
lightcone0 added a commit that referenced this pull request Mar 20, 2026
Hooks into Pi's extension API for persistent cross-session memory.
Fills the #1 community pain point — session amnesia.

- 3 memory tools (write, search, list) registered via pi.registerTool()
- Lifecycle hooks: fact extraction on turn_end, context injection on
  before_agent_start, reconciliation on session_shutdown
- 7 tests covering tool registration, lifecycle events, fact extraction
- README with researched pain points (Issue #1182, #92, #116, #1255),
  5 use cases (project patterns, preferences, cross-project knowledge,
  surviving compaction, superseding), comparison with pi-hippocampus
- Updated main README, publish.sh, architecture diagram

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.

2 participants