docs: rewrite root README — narrative, comparison, honesty, ADR links#278
Open
EmersonBraun wants to merge 1 commit intomainfrom
Open
docs: rewrite root README — narrative, comparison, honesty, ADR links#278EmersonBraun wants to merge 1 commit intomainfrom
EmersonBraun wants to merge 1 commit intomainfrom
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Tightened
Preserved
Honest about dependencies
This PR references files that land in other open PRs:
MANIFESTO.md,ORIGIN.md, RFC issue template — in foundation: manifesto, origin, governance templates, and Phase 0 planning docs #265Recommended merge order: #265 → #267..#274 → #277 → this PR. Links resolve correctly once the referenced files are on
main.Test plan
pnpm lint(TypeScript-only, paste-test)Refs #224 #16 #211