Skip to content

Slim the README to match our other repos - #51

Merged
setoelkahfi merged 1 commit into
developmentfrom
docs/slim-readme
Nov 2, 2026
Merged

setoelkahfi merged 1 commit into
developmentfrom
docs/slim-readme

Conversation

@setoelkahfi

Copy link
Copy Markdown
Collaborator

The root README had grown into a pitch essay, a showcase list, an API walkthrough and two crate tables. This brings it in line with onde-code, siGit Code and smbcloud-cli: logo, tagline, badges, one paragraph, Install, Quick start, Use it your way, Docs, Contributing, License.

  • The API detail (lifecycle, EventSink, tool approval, ChatReply, usage) already lives in crates/ed-agent/README.md, so the root links there instead of repeating it.
  • The quick start no longer pins ed-agent = "1.2", so it can't go stale.
  • ed-acp-tauri and ed-claude, which ship in 1.4.0 (Release 1.4.0 #50), were missing from the crate tables. They are in the new "Use it your way" list.
  • "Why it exists" and the four-item showcase are gone. The showcase is now one "In production" line.
  • No em dashes.

Only README.md changes. This is separate from the release PR; crates.io shows each crate's own README, so merge order doesn't matter much.

Cut the pitch essay, showcase list, API walkthrough and crate tables.
Add badges, an install section and a "Use it your way" list that now
covers ed-acp-tauri and ed-claude. The quick start no longer pins a
version. The API detail lives in crates/ed-agent/README.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

@sigit-code-review sigit-code-review 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.

Slims the root README to logo, tagline, badges, one paragraph, Install, Quick start, Use it your way, Docs, Contributing, and License. It removes the duplicated API walkthrough and crate tables, linking out to crate READMEs instead, and adds ed-acp-tauri and ed-claude to the newer lists. No code paths change, and no issues found in the diff.


Automated review by siGit Code Review · commit 42751e6 · see the review dashboard

@setoelkahfi
setoelkahfi merged commit 299eff1 into development Nov 2, 2026
1 check passed
@setoelkahfi
setoelkahfi deleted the docs/slim-readme branch November 2, 2026 11:09
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.

4 participants