Skip to content

docs(readme): reframe 'Why this exists' around consumer hardware + offline#39

Merged
jaylfc merged 1 commit intomasterfrom
docs/readme-hardware-positioning
Apr 20, 2026
Merged

docs(readme): reframe 'Why this exists' around consumer hardware + offline#39
jaylfc merged 1 commit intomasterfrom
docs/readme-hardware-positioning

Conversation

@jaylfc
Copy link
Copy Markdown
Owner

@jaylfc jaylfc commented Apr 20, 2026

Summary

  • Replaces the library/librarian narrative in the 'Why this exists' section with a direct statement of who the project is for
  • Four target audiences: modest-hardware users, distributed-small-machines users (taOS cluster), offline/air-gapped, zero-loss/archival-first
  • Preserves the architectural point (verbatim archive first, summaries on top) as a bullet
  • Adds the load-bearing fact that the 97% was measured on the Pi stack, not on a hosted model

Not changing

Test plan

  • README renders cleanly on GitHub
  • No orphaned references to "the librarian" / "the library" in the rest of the main README (Architecture section's Librarian Layer heading is a component name and is untouched)

Summary by CodeRabbit

  • Documentation
    • Updated project description to emphasize compatibility with modest hardware, multi-node distribution, and offline scenarios
    • Added hardware performance measurement (97.0% on Orange Pi 5 Plus)
    • Clarified zero cloud dependencies and zero API key requirements

…fline

Replace the library/librarian narrative with a direct statement of who the project is for:
modest-hardware users (Pi 5, old laptop, Mac mini), distributed-across-small-machines users
(taOS cluster), offline/air-gapped workflows, and zero-loss/archival-first users. Keeps the
zero-loss architecture point (verbatim archive first, summaries on top) as a bullet instead
of a metaphor. Adds the load-bearing fact that the 97% was measured on the Pi stack, not on
a hosted model.
@jaylfc jaylfc merged commit dacde55 into master Apr 20, 2026
@jaylfc jaylfc deleted the docs/readme-hardware-positioning branch April 20, 2026 18:24
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 20, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 040eb3a3-a9c8-4b81-abf1-ec5f76415369

📥 Commits

Reviewing files that changed from the base of the PR and between 04b01ca and 540b11f.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md updated to replace a library/librarian metaphor narrative with constraint-focused operational scenarios emphasizing offline usage, multi-node distribution, and modest hardware. Added explicit hardware benchmark claim and removed cloud/API dependency language.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Replaced "Why this exists" narrative framing with constraint-focused bullets highlighting unsuitability of hosted/cloud-model benchmarking. Added hardware measurement claim (97.0% on LongMemEval-S, Orange Pi 5 Plus) and zero cloud/API dependencies statement.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

A rabbit rewrote the tale,
No clouds, no keys, just scales—
On humble Pi, the numbers sing,
Append-only memories wing. 🐇✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-hardware-positioning

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

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