docs: rewrite README top fold and trim Examples section#95
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1371217c82
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| const developer: AgentConfig = { /* same shape, tools: ['bash', 'file_read', 'file_write', 'file_edit'] */ } | ||
| const reviewer: AgentConfig = { /* same shape, tools: ['file_read', 'grep'] */ } |
There was a problem hiding this comment.
The Quick Start code now defines developer and reviewer as empty AgentConfig objects, which makes the snippet non-runnable for copy/paste users: AgentConfig requires at least name and model, so this fails type-checking immediately, and if run without type-checking it can still break orchestration because team members are missing required metadata. Since this section is presented as executable setup, replacing full objects with placeholders is a functional docs regression.
Useful? React with 👍 / 👎.
Strategic rewrite following docs/project-evaluation-2026-04-09.md. README.md and README_zh.md updated in lockstep. Top fold changes: - New tagline positioning against CrewAI and LangGraph - Replace 11-bullet "Why" with 3 bullets (runTeam / 3 deps / multi-model) - New Philosophy section with "we build / we don't build / tracking" - "We don't build" limited to handoffs and checkpointing (softened); Cloud/Studio bullet dropped to preserve future Hosted option - New "How is this different from X?" FAQ covering LangGraph JS, CrewAI, and Vercel AI SDK - New "Used by" section with three early-stage integrations, framed honestly for a new project (temodar-agent, rentech-quant-platform, cybersecurity SOC home lab) Examples section: - Shrink 15-row catalog table to 4 featured entries + link to examples/ - Featured: 02 team collaboration, 06 local model, 09 structured output, 11 trace observability - Eliminates maintenance debt of updating the table on every new example Refinements during alignment pass: - Launch date corrected to 2026-04-01 (matches first commit timestamp) - Surface Gemini @google/genai peer dep in top fold and Providers table - Rephrase "Agent handoffs" bullet to avoid reading as single-agent framework - Update prose example to Opus 4.6 / GPT-5.4 / local Gemma 4 - Quick Start code example shortened ~30% (developer/reviewer collapsed to stubs, still demonstrates multi-agent team shape) - Remove CrewAI endorsement stats (48K stars / Andrew Ng / $18M) to keep comparisons technical - Drop Star History cache-buster since growth has stabilized; bump contributors cache-buster to max=20 so all 8 contributors render - Delete Author section; shrink Contributing to Examples + Documentation Small carry-over fixes: - Fix duplicated task_complete line in Quick Start output sample - Add AgentPool.runParallel() note to Three Ways to Run - Update source file count 33 → 35 Kept unchanged per scope: - Architecture diagram, Built-in Tools, Supported Providers Does not touch source code or package.json.
JackChen-me
force-pushed
the
docs/readme-top-fold-rewrite
branch
from
1371217 to
e0fd186
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e0fd1860fc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| const developer: AgentConfig = { /* 同样结构，tools: ['bash', 'file_read', 'file_write', 'file_edit'] */ } | ||
| const reviewer: AgentConfig = { /* 同样结构，tools: ['file_read', 'grep'] */ } |
There was a problem hiding this comment.
The new Quick Start snippet replaces developer and reviewer with comment-only placeholders, so copy/pasting this section is no longer runnable: AgentConfig requires concrete fields like name and model, and this now fails type-checking (or runtime setup) before users can run runTeam(). Because this section is presented as executable onboarding code, this is a functional docs regression for Chinese readers.
Useful? React with 👍 / 👎.
1 participant
Summary
Strategic rewrite of the README top fold and Examples section, per
docs/project-evaluation-2026-04-09.md. BothREADME.mdandREADME_zh.mdupdated in lockstep.See the commit message for the full change breakdown.
Test plan