docs: SEO overhaul — rank for LLM memory decay searches#15
Merged
Conversation
Full discoverability push to rank for LLM memory decay searches: GitHub metadata: - 20 keyword-rich topics (llm-memory, memory-decay, ebbinghaus, rag-evaluation, temporal-decay, conversation-memory, llm-benchmark...) - Description updated with all 5 backends + key differentiators README.md (main SEO asset): - "How MemoryLens Compares" table vs RAGAS, TruLens, DeepEval, MemGPT - Multi-seed results table (mean +/- std, n=5) - Decay ablation table with citations - All 5 backends and 5 providers documented - Updated project structure with all new files - LLM provider table with free-tier flags - Proper citation block + star history New files: - CITATION.cff: citable software; GitHub shows "Cite this repository" sidebar panel; indexed by Zenodo and OpenAlex - pyproject.toml: pip-installable package, 15 PyPI keywords, extras for optional providers (groq/openai/anthropic/all-providers) - docs/why-memory-evaluation-matters.md: long-form explanation of LLM memory decay — targets "why does LLM forget" search queries - docs/comparison-with-existing-tools.md: RAGAS vs MemoryLens etc — captures traffic from people searching for competing tools - docs/adding-a-new-backend.md: full guide with EntityMemory example Updated: - CONTRIBUTING.md: reflects all shipped features, updated good-first-issue table, link to new backend guide - ROADMAP.md: all v0.3 items checked, v0.4/v0.5 with clear descriptions - Issue templates: keyword-rich descriptions for GitHub search indexing Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR is a documentation/metadata overhaul aimed at improving discoverability for “LLM memory decay”–related searches, while also introducing initial Python packaging metadata (CITATION + pyproject.toml) to make the project more citable and installable.
Changes:
- Expands
README.mdandROADMAP.mdwith SEO-targeted positioning, comparison tables, and updated benchmark/result narratives. - Adds new long-form docs pages under
docs/to target specific search queries and guide contributions. - Introduces
CITATION.cffandpyproject.tomlto support GitHub citation UX and Python packaging/entry points.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| ROADMAP.md | Reframes roadmap around v0.3 shipped items and v0.4/v0.5 plans with SEO-forward wording |
| README.md | Major SEO/content expansion: results tables, comparisons, provider matrix, updated structure tree, citation block |
| pyproject.toml | Adds packaging metadata, dependencies, extras, and a CLI entry point |
| docs/why-memory-evaluation-matters.md | New explainer article targeting “why LLMs forget / memory decay” queries |
| docs/comparison-with-existing-tools.md | New comparison page vs RAGAS/TruLens/DeepEval/MemGPT/LangChain |
| docs/adding-a-new-backend.md | New contributor guide for adding memory backends (worked EntityMemory example) |
| CONTRIBUTING.md | Updates contributor onboarding and adds persona/scenario contribution guidance |
| CITATION.cff | Adds standard citation metadata for GitHub “Cite this repository” support |
| .github/ISSUE_TEMPLATE/new_backend.md | Expands backend issue template to capture research hypothesis + expected decay behavior |
| .github/ISSUE_TEMPLATE/feature_request.md | Expands feature request template to better fit benchmark/backend/scenario requests |
Comments suppressed due to low confidence (1)
pyproject.toml:72
- The console script points at
main:main, butmain.pyis a top-level module and isn’t included by the current setuptools config (only packages matchingmemory*,evaluation*,simulator*,utils*are discovered). This will make the installedmemorylenscommand fail withModuleNotFoundError: No module named 'main'. Either move the CLI into an importable package module (e.g.memorylens/cli.py) or explicitly includemainas apy-modulesentry / package it so the entry point resolves after installation.
[project.scripts]
memorylens = "main:main"
[project.urls]
Homepage = "https://github.com/Neal006/memorylens"
Repository = "https://github.com/Neal006/memorylens"
"Bug Tracker" = "https://github.com/Neal006/memorylens/issues"
Documentation = "https://github.com/Neal006/memorylens#readme"
Paper = "https://github.com/Neal006/memorylens/blob/main/paper/memorylens_paper.md"
[tool.setuptools.packages.find]
include = ["memory*", "evaluation*", "simulator*", "utils*"]
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,74 @@ | |||
| [build-system] | |||
| requires = ["setuptools>=68", "wheel"] | |||
| build-backend = "setuptools.backends.legacy:build" | |||
Comment on lines
+56
to
+57
| anthropic = ["anthropic>=0.25.0"] | ||
| all-providers = ["groq>=0.9.0", "openai>=1.0.0", "anthropic>=0.25.0"] |
| "Programming Language :: Python :: 3", | ||
| "Programming Language :: Python :: 3.10", | ||
| "Programming Language :: Python :: 3.11", | ||
| "Programming Language :: Python :: 3.12", |
| - family-names: Srivastava | ||
| given-names: Neal | ||
| alias: Neal006 | ||
| orcid: "" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What This PR Does
Full discoverability push across Google and GitHub for the keywords: LLM memory decay, memory decay benchmark, LLM memory evaluation, RAG memory benchmark, temporal drift LLM, Ebbinghaus LLM memory.
GitHub repo metadata (already live)
gh repo edit:llm-memory,memory-decay,ebbinghaus,rag-evaluation,temporal-decay,conversation-memory,llm-benchmark,memory-evaluation,ai-evaluation,chatbot+ 10 existingREADME.md — the main SEO asset
## How MemoryLens Comparestable: head-to-head vs RAGAS, TruLens, DeepEval, MemGPT, LangChain ConversationBuffer — captures search traffic for competing toolsCITATION.cff (new)
Standard software citation file — GitHub displays a "Cite this repository" panel in the sidebar when this file exists. Also indexed by Zenodo, OpenAlex, and Google Scholar.
pyproject.toml (new)
pip install memorylens[groq]memorylensCLI commanddocs/ (3 new files)
why-memory-evaluation-matters.mdcomparison-with-existing-tools.mdadding-a-new-backend.mdOpen issues (3 new searchable issue titles)
🤖 Generated with Claude Code