Skip to content

docs: fix README typos and copy bugs#1500

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
HugoTheCat:docs/readme-typos
May 11, 2026
Merged

docs: fix README typos and copy bugs#1500
senamakel merged 1 commit into
tinyhumansai:mainfrom
HugoTheCat:docs/readme-typos

Conversation

@HugoTheCat
Copy link
Copy Markdown
Contributor

@HugoTheCat HugoTheCat commented May 11, 2026

Summary

  • Fix three copy bugs in README.md — no code changes.
  • Notably, the TokenJuice bullet was claiming the layer increases latency (the opposite of intent).

Problem

  • non-Asccii typo (line 57).
  • TokenJuice bullet (line 57): Reducing costs & increasing latency by upto 80% — reads as a regression and contains upto.
  • Memory Trees sentence (line 73): have [Memory Trees](…) compresses everything — subject/verb disagreement under the have X do Y construction.
  • Intro sentence (line 75): In just one sync pass and the agent has full (compressed) context your inbox… — dangling and, and missing of after context.

Solution

  • non-Ascciinon-ASCII.
  • Reducing costs & increasing latency by upto 80%Reducing cost & latency by up to 80%.
  • have Memory Trees compresseshave Memory Trees compress.
  • In just one sync pass and the agent has full (compressed) context your inbox…In just one sync pass, the agent has full (compressed) context of your inbox….

Submission Checklist

  • Tests added or updated — N/A: README copy fix, no behavior change.
  • Diff coverage ≥ 80%N/A: documentation-only change, no executable lines.
  • Coverage matrix updated — N/A: behaviour-only change (no feature added/removed/renamed).
  • All affected feature IDs listed under ## RelatedN/A: no feature touched.
  • No new external network dependencies introduced — N/A: no code change.
  • Manual smoke checklist updated — N/A: not a release-cut surface.
  • Linked issue closed via Closes #NNNN/A: no tracking issue.

Impact

  • Documentation only. No runtime/platform impact.

Related

  • Closes: N/A
  • Follow-up PR(s)/TODOs: none.

AI Authored PR Metadata (required for Codex/Linear PRs)

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: docs/readme-typos
  • Commit SHA: 54f2f038

Note to reviewers

Pre-push hook (pnpm format:check) failed locally with sh: cargo: command not found in its rust:format:check step — environment issue, unrelated to this README-only change. Prettier itself reported "All matched files use Prettier code style!" before the cargo step failed. Pushed with --no-verify per the project's documented policy for pre-existing/unrelated hook failures.

Summary by CodeRabbit

  • Documentation
    • Updated feature descriptions for clarity and accuracy
    • Refined explanation of smart token compression benefits and cost/latency reductions
    • Clarified how context compression and storage works

Review Change Stack

- "non-Asccii" -> "non-ASCII"
- "Reducing costs & increasing latency by upto 80%" -> "Reducing cost & latency by up to 80%" (was claiming latency went up)
- "have Memory Trees compresses" -> "have Memory Trees compress"
- "context your inbox" -> "context of your inbox", with the dangling "and" cleaned up
@HugoTheCat HugoTheCat requested a review from a team May 11, 2026 18:44
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ba9e1e63-c591-4d14-8655-262b3269c886

📥 Commits

Reviewing files that changed from the base of the PR and between 2426110 and 54f2f03.

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

📝 Walkthrough

Walkthrough

README.md receives two documentation updates: the TokenJuice feature description is reworded to fix typos and clarify cost/latency reduction impact, and the auto-fetch context section is rewritten to correct the explanation of periodic sync, Memory Trees compression to Markdown, Obsidian wiki storage, and context availability.

Changes

Documentation Updates

Layer / File(s) Summary
TokenJuice Feature Description
README.md
TokenJuice feature bullet corrected for typos and reworded to state "Reducing cost & latency by up to 80%" instead of "increasing latency."
Auto-Fetch Context Section
README.md
"Context in minutes, not weeks" section rewritten to clarify periodic auto-fetch loop, Memory Trees compression to Markdown files stored in Obsidian-style wiki, and full compressed context availability after one sync pass.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 With whiskers twitched and nose held high,
The prose now flows, no typos nigh!
Token juice squeezed, context flows free,
In Markdown trees, for all to see.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@senamakel senamakel merged commit 089ffe0 into tinyhumansai:main May 11, 2026
1 check was pending
@senamakel
Copy link
Copy Markdown
Member

merged baby

@coderabbitai coderabbitai Bot mentioned this pull request May 15, 2026
12 tasks
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
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