Skip to content

docs: Refactor README positioning to highlight cost savings, zero-overhead UX, and visual proof #762

Description

@fajarhide

Feature Idea

Overview

Currently, the OMNI README provides deep technical details on how the distillation engine and ledger work. However, for new developers or teams considering adoption, the core financial and UX benefits can be made more immediate.

Refactoring the main documentation will help articulate OMNI's value proposition faster and reduce friction during initial evaluation.

Proposed Changes

  1. Value-First Headline & Hooks:
    • Emphasize direct outcomes early: context window optimization, lower API bills for agentic sessions (e.g., Claude Code / Codex / Aider), and elimination of context degradation.
  2. Visual Before-and-After Comparisons:
    • Add clear side-by-side terminal screenshots or ASCII diagrams contrasting a noisy output (cargo test / docker build) vs. distilled OMNI output.
  3. Interactive ROI / Savings Callout:
    • Highlight real-world token savings upfront alongside the existing benchmarks to instantly signal utility to developers managing heavy CLI agent workflows.

Tasks

  • Draft concise value-proposition section at the top of README.md.
  • Create visual assets (SVG/PNG or clean code blocks) showing side-by-side terminal reduction.
  • Add a "Why OMNI?" section targeting developer agent workflows.

Why is this needed?

The current documentation focuses heavily on technical implementation (ledger mechanisms, RewindStore, schemas). New users need to instantly understand the business and workflow value within 5 seconds of landing on the repository, rather than parsing internal architectural details first.

​## What is the token-savings impact or use-case?

​Use-case: Developers evaluating OMNI to reduce LLM API overhead across agentic sessions.
Impact: Clearly communicates the 24.1% average session-wide repetition reduction (up to 97.2% on duplicate file reads and 93% on build output) directly upfront. Converting immediate understanding into adoption directly lowers multi-turn agent input token costs for users.

Alternatives Considered

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority: lowNeeds a decision first / meta metricstage: laterAn open question is unanswered, so nobody can size it

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions