Skip to content

Polish README with actual TUI screenshots#34

Merged
TerminallyLazy merged 1 commit into
mainfrom
codex/readme-app-screenshots
Jul 9, 2026
Merged

Polish README with actual TUI screenshots#34
TerminallyLazy merged 1 commit into
mainfrom
codex/readme-app-screenshots

Conversation

@TerminallyLazy

@TerminallyLazy TerminallyLazy commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Tidy the README top section with a clearer agent-focused overview and quick start
  • Add actual tree-ring tui screenshots captured from a populated local store, covering dashboard, search, evidence, and integrations views
  • Update certification/evidence text with current install size, recall speed, harness matrix, and recall-quality numbers

Notes

  • Screenshots are from the real TUI running against a synthetic local .tree-ring store populated through the public CLI with 47 varied memories across all rings.
  • The fixture was regenerated to avoid repeated dummy rows in the visible memory list.

Checks

  • git diff --check
  • cargo fmt --check

Summary by CodeRabbit

  • Documentation
    • Refreshed the README with a clearer introduction and onboarding flow.
    • Added a screenshots section and a new quick-start sequence for getting started faster.
    • Updated launch links, install guidance, and protocol preview history details.
    • Revised command examples and output locations to match the latest workflow.
    • Renewed the development check results and reported metrics with updated timestamps.

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9f16f53c-c9e1-4ccd-8991-4c37f9c97afb

📥 Commits

Reviewing files that changed from the base of the PR and between 4f6884e and 0499dc8.

⛔ Files ignored due to path filters (4)
  • docs/assets/readme-tui-dashboard.png is excluded by !**/*.png
  • docs/assets/readme-tui-evidence.png is excluded by !**/*.png
  • docs/assets/readme-tui-integrations.png is excluded by !**/*.png
  • docs/assets/readme-tui-search.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md is restructured with a new protocol-preview introduction, refreshed launch links, a collapsible preview history section, a Screenshots section, and a new Quick Start command flow replacing the earlier First Example section. Certification metrics and a recall-quality path reference are also updated.

Changes

README Restructuring

Layer / File(s) Summary
Intro and launch links rewrite
README.md
Replaces the Status block with a protocol-preview description, adds a "Current launch links" list, and converts version history into a collapsible "Protocol preview history" section; updates "What It Gives Agents" bullets.
Screenshots and quick start flow
README.md
Adds a Screenshots section with tui screenshots, introduces a "Quick Start" section replacing "Install", adds init/remember/recall/tui command sequence and "Install Details" entry, and removes the old "First Example" section.
Certification metrics and recall-quality path update
README.md
Updates the recall-quality merge step to reference target/tree-ring-certification/evidence-index.json, and refreshes the certification run metrics block with new timestamp, sizes, timing figures, harness counts, and Agent Zero plugin smoke status.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/readme-app-screenshots

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.

@TerminallyLazy TerminallyLazy merged commit 65354ff into main Jul 9, 2026
1 of 2 checks passed

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md to clarify that Tree Ring Memory is a local-first framework, reorganizes the launch links and protocol preview history, and adds a new 'What It Gives Agents' section. It also introduces a 'Screenshots' section showing the TUI application, restructures the 'Quick Start' and installation examples, corrects paths for certification artifacts, and updates the latest certification run metrics and timestamps. There are no review comments, so no feedback is provided.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

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