docs(readme): tighten tagline + bullet wording - #568
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates README.md marketing copy to refine product messaging, clarify installation and usage flow, and emphasize locality, auditability, and performance of the tool. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ 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. 📝 WalkthroughWalkthroughREADME.md marketing copy is refined across three sections: the hero tagline now emphasizes "Local SQLite. Fully auditable. No GPU, no network," the background benefit claim shifts from "stops the forgetting" to "stops the amnesia and context drift," and the differentiators bullets are reworded with tightened claims about auditability, reversibility, and local operation. ChangesMarketing Copy Updates
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly Related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The new
# To Install:and## Optionalheadings break the existing heading hierarchy and read a bit awkwardly; consider renaming them to something like## Installationand### Optional: ...(e.g., “Optional: Add your first rule”) to keep the structure consistent and self-explanatory. - Some of the new marketing-style phrases (e.g., “stops the amnesia and context drift”, “You're the boss of your memories.”, “Operations are fast and local.”) add extra words without much new information; tightening or removing them would keep the README concise while preserving clarity.
- The modified bullet about being auditable now adds “Query it with the tools; full traceability.”, which is a bit vague—if you keep it, consider briefly clarifying what “the tools” refers to (e.g.,
sqlite3, a specific GUI, or CLI examples).
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new `# To Install:` and `## Optional` headings break the existing heading hierarchy and read a bit awkwardly; consider renaming them to something like `## Installation` and `### Optional: ...` (e.g., “Optional: Add your first rule”) to keep the structure consistent and self-explanatory.
- Some of the new marketing-style phrases (e.g., “stops the amnesia and context drift”, “You're the boss of your memories.”, “Operations are fast and local.”) add extra words without much new information; tightening or removing them would keep the README concise while preserving clarity.
- The modified bullet about being auditable now adds “Query it with the tools; full traceability.”, which is a bit vague—if you keep it, consider briefly clarifying what “the tools” refers to (e.g., `sqlite3`, a specific GUI, or CLI examples).Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
This PR is now behind Auto-rebase was removed because the bot has no signing key; rebasing as the bot strips author signatures and the |
robotrocketscience
enabled auto-merge (rebase)
May 10, 2026 06:13
auto-merge was automatically disabled
May 10, 2026 06:13
Branch protection rule check failed
5 tasks
Owner
Author
|
[claim:review:godel:2026-05-10T17:27:54Z] |
robotrocketscience
added a commit
that referenced
this pull request
May 10, 2026
Marketing-tone edits salvaged from #568 (which was opened against a pre-v2.0 README via web UI; the destructive parts — Session-start section deletion + v2.1.0 → v1.7 Status revert — are dropped). Net change: tagline (forgetting your rules → forgetting; your way → the way; Auditable → Fully auditable), lead-paragraph framing (stops the forgetting → stops the amnesia and context drift), and four bullet-tone tweaks (Local-only, Auditable, Reversible, No GPU).
robotrocketscience
force-pushed
the
robotrocketscience-patch-1
branch
from
May 10, 2026 18:08
1559e8d to
645a304
Compare
robotrocketscience
changed the title
Owner
Author
|
Salvaged: dropped the destructive parts (Session-start subsection deletion + v2.1.0 → v1.7 Status revert + stray |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 49: Standardize the SQLite path placeholder in README.md by replacing the
variant `<git-common-dir>/aelfrice/memory.db` with the same format used
elsewhere (`<repo>/.git/aelfrice/memory.db`) (or vice versa—pick one canonical
placeholder) so both occurrences match; update the text that mentions
`~/.aelfrice/memory.db` only if you choose to normalize examples, and ensure the
two specific strings `<git-common-dir>/aelfrice/memory.db` and
`<repo>/.git/aelfrice/memory.db` are identical across the document to avoid
confusion.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| - **Auditable to the row.** Every belief has an `origin` column (`user_stated`, `user_corrected`, `commit_ingest`, …) tying it to the action that wrote it. Open the DB in any SQLite browser; nothing hidden. | ||
| - **Reversible.** `aelf uninstall --archive backup.aenc` encrypts the DB and deletes the live copy. `--purge` wipes it. `--keep-db` leaves data untouched. No vendor lock-in by construction. | ||
| - **No GPU, no network, no inference cost.** Runtime deps are `numpy`, `scipy`, `snowballstemmer` — all CPU, all offline. Retrieval is a sparse-matrix query, not a model call. | ||
| - **Local-only.** SQLite at `<git-common-dir>/aelfrice/memory.db` (or `~/.aelfrice/memory.db` outside git). No network calls, no telemetry, no accounts. One brain per project, all on your machine. ([PRIVACY.md](docs/PRIVACY.md)) |
There was a problem hiding this comment.
Inconsistent path format with line 138.
This line describes the SQLite location as <git-common-dir>/aelfrice/memory.db, but line 138 describes the same location as <repo>/.git/aelfrice/memory.db. While these may refer to the same location technically, the inconsistent placeholder formats could confuse readers. Consider standardizing on one format throughout the document.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 49, Standardize the SQLite path placeholder in README.md
by replacing the variant `<git-common-dir>/aelfrice/memory.db` with the same
format used elsewhere (`<repo>/.git/aelfrice/memory.db`) (or vice versa—pick one
canonical placeholder) so both occurrences match; update the text that mentions
`~/.aelfrice/memory.db` only if you choose to normalize examples, and ensure the
two specific strings `<git-common-dir>/aelfrice/memory.db` and
`<repo>/.git/aelfrice/memory.db` are identical across the document to avoid
confusion.
Marketing-tone edits salvaged from #568 (which was opened against a pre-v2.0 README via web UI; the destructive parts — Session-start section deletion + v2.1.0 → v1.7 Status revert — are dropped). Net change: tagline (forgetting your rules → forgetting; your way → the way; Auditable → Fully auditable), lead-paragraph framing (stops the forgetting → stops the amnesia and context drift), and four bullet-tone tweaks (Local-only, Auditable, Reversible, No GPU).
robotrocketscience
force-pushed
the
robotrocketscience-patch-1
branch
from
May 10, 2026 18:18
645a304 to
2c6a71a
Compare
Owner
Author
|
[release:review:godel:2026-05-10T21:43:55Z] |
This was referenced May 10, 2026
This was referenced May 13, 2026
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
1 participant
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.
Summary
Linked issues
-->Type of change
feat:— new featurefix:— bug fixperf:— performance improvementrefactor:— code restructure with no behavior changetest:— test-only changedocs:— documentation-only changebuild:— build system / dependency / lockfile changeci:— CI workflow / hook changerelease:— version bump / release tagchore:— narrow housekeepingVerification
uv run pytest tests/ -x -q— all greenuv run pyright src/— strict, no new errorsuv run aelf --help— surface unchanged (or change documented)[Unreleased](if user-visible)Test plan
Notes for reviewer
Summary by Sourcery
Update the README to refine product messaging and clarify installation and data-ownership semantics.
Documentation:
Summary by CodeRabbit