Skip to content

Add explicit “Why / Use cases” section to README for first-time users #294

@chaollapark

Description

@chaollapark

Problem or use case

New users can miss what Entire is for within the first minute: not just “stores sessions,” but making AI-agent coding auditable + rewindable, so you can review, debug, and resume work safely. A short “Why / Use cases” section near the top would reduce confusion and improve onboarding.

Proposed change (lightweight):
Add 4–6 bullets under a “Why” or “Use cases” heading near the top of README.md (or docs intro), e.g.:

Review why an agent changed code (prompt/response transcript + files touched)

Rewind to a known-good checkpoint when an agent goes sideways

Keep git history clean while preserving agent context on a separate branch

Onboard teammates by showing the path from prompt → change → commit

Support audit/compliance-style traceability when needed

This matches what the tool already does; the docs would just make the intent more obvious.

Where:
Likely README.md right after the first paragraph / before “Quick Start.” (Docs intro could also work.)

Why now:
There are already multiple issues about adding support for more agents (Cursor, Goose, etc.), so clearer positioning for newcomers is timely.

Desired behavior

Proposed solution

No response

Alternatives or workarounds

No response

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions