Skip to content

docs: rewrite root README — narrative, comparison, honesty, ADR links#278

Open
EmersonBraun wants to merge 1 commit intomainfrom
foundation/readme-rewrite
Open

docs: rewrite root README — narrative, comparison, honesty, ADR links#278
EmersonBraun wants to merge 1 commit intomainfrom
foundation/readme-rewrite

Conversation

@EmersonBraun
Copy link
Copy Markdown
Owner

Summary

Story-driven rewrite of the root README. Closes #224 and #16.

The previous README was decent but generic ('complete toolkit'). This version positions AgentsKit as opinionated, contracted, honest — and routes readers immediately to the Manifesto, Origin, ADRs, and agentskit.io.

What changed

New

  • Opinionated tagline — 'The agent toolkit JavaScript actually deserves'
  • 'Why this exists' section calling out the actual gaps in Vercel AI SDK / LangChain.js / MCP / assistant-ui — and linking to ORIGIN.md and MANIFESTO.md for the long version
  • Before / After section — cobbled multi-library stack vs two-import AgentsKit equivalent
  • Honest 'When you should NOT use AgentsKit' section directing readers to:
    • The OpenAI SDK directly for single-call use cases
    • Vercel AI SDK for chat-only products
    • Python frameworks
    • Mature observability platforms (LangSmith/Arize/Helicone)
    • A v1.0.0 wait if pre-1.0 risk is a blocker
  • Architecture and contracts section linking all six ADRs
  • Status section linking Phase 0 PRD [Master PRD] Phase 0 — Foundation Hardening (antes da Fase 1) #211 and Master PRD [Master PRD] AgentsKit Roadmap — 4 phases, 97 user stories #113
  • For AI agents callout — first-class consumers of our docs
  • agentskit.io as canonical docs URL

Tightened

  • Single 10-line quickstart instead of three competing ones
  • Comparison table now includes formal-contracts and edge-readiness rows
  • Ecosystem table now shows stability tier per package

Preserved

  • Multi-agent delegation example
  • Provider-swap-in-one-line demonstration
  • Terminal chat callout

Honest about dependencies

This PR references files that land in other open PRs:

Recommended merge order: #265#267..#274#277 → this PR. Links resolve correctly once the referenced files are on main.

Test plan

  • Markdown renders cleanly on GitHub
  • All internal anchors resolve (Manifesto, Origin, ADRs, packages/*)
  • Code blocks compile in pnpm lint (TypeScript-only, paste-test)
  • Reviewer: read aloud — does the tone feel earned or pushy?
  • Reviewer: spot-check 'When you should NOT use' section for fairness
  • Reviewer: comparison table accurate vs current state of competitors?

Refs #224 #16 #211

Reframes the README from a generic 'complete toolkit' pitch to an
opinionated, honest, story-driven entry point.

What's new:
- Tagline 'The agent toolkit JavaScript actually deserves' — opinion,
  not buzzwords
- 'Why this exists' section linking to ORIGIN.md and MANIFESTO.md
- 'Before and after' section showing the typical cobbled stack vs
  AgentsKit's two-import equivalent
- Honest 'When you should NOT use AgentsKit' section — directs people
  to single-OpenAI-call, Vercel AI SDK for chat-only, Python frameworks,
  mature observability platforms, or pre-1.0 caution
- Comparison table now includes formal contracts row and edge-readiness
- Stability tier column on the ecosystem table
- Architecture and contracts section linking the six ADRs
- 'For AI agents reading this' section — first-class doc consumers
- Status section linking Phase 0 and Master PRDs
- agentskit.io as canonical docs URL

What's preserved and tightened:
- Quickstart in 10 lines (single example, not three competing)
- Multi-agent delegation example
- Provider swap demonstration
- Terminal chat (Ink) callout

Aligns with stories #224 (README rewrite) and #16 (honest comparison
incl. when NOT to use). Builds on Manifesto + Origin (#265) and the
six contract ADRs (#267-#274).

Refs #224 #16 #211
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.

[P0.13] Rewritten root README (tagline + origin + before/after + honest comparison)

1 participant