docs(README): refresh positioning, branding, and section layout#176
Merged
Conversation
- Move "How is this different from X?" and Ecosystem to after Examples - Sync README_zh.md with English (Qiniu, OpenRouter, Translations) - Add quantized tuning section linking to local-quantized.ts - Trim line 22 feature list, bump cache-bust dates
- Add brand assets (logo marks, banners, social cards) under .github/brand/ - Hero: "Lightweight multi-agent orchestration for TypeScript" - Body anchored on mechanism (Coordinator decomposes goals into a task DAG) and pain pivot (describe the goal, not the graph) - Reorder badges to package -> stack -> quality -> brand position -> social proof - Rewrite "What else you get" around tool framework + delegation, production features (incl. post-run task DAG dashboard), and cross-provider teams - Add vs. Mastra comparison anchored on Supervisor vs Coordinator architecture - Move Featured Partner out of Ecosystem to a bottom standalone section - Merge Translations into Contributing - Drop "(free)" qualifier from Integrations subsection - Sync zh README throughout
![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: 32dd8614c7
ℹ️ 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".
Comment on lines
+3
to
+5
| <source media="(prefers-color-scheme: dark)" srcset=".github/brand/logo-mark-dark.svg"> | ||
| <source media="(prefers-color-scheme: light)" srcset=".github/brand/logo-mark-light.svg"> | ||
| <img alt="Open Multi-Agent" src=".github/brand/logo-mark-light.svg" width="96"> |
There was a problem hiding this comment.
The new hero logo references .github/brand/... via relative paths, but .github is not part of the published package contents (package.json only ships dist, docs, README.md, and LICENSE). As a result, the README on npm renders broken images at the top, which hurts first-run documentation quality for package users. Please use absolute GitHub-hosted asset URLs (or ship the brand assets in the package).
Useful? React with 👍 / 👎.
- Quick Start: add `### Run a team in TypeScript` heading for the runTeam code example; move CLI mention after the SDK example as `### Run from the shell` - Supported Providers: drop redundant "Status: Verified" column; add Example model and Notes columns covering all 14 providers - Remove `### LLM Configuration Examples` subsection; info now lives in the main table with a generic code template above it - Sync README_zh.md throughout
Evaluation pass that fixes factual errors (missing cookbook category, ambiguous delegate_to_agent, broken Quick Start placeholders, duplicate task names in demo output) and improves discoverability via a 10-row Features table, a 30-second clone-and-run Quick Start, cookbook-first Examples, an Observability section, provider tables split by user-facing config, trimmed comparison sections, and a Production Checklist. Featured Partner program details move to docs/featured-partner.md so the README ends on License rather than a paywall, with a brief Ecosystem subsection linking to the new doc.
- Light banner no longer shows the body var(--bg) bleeding through on the right; dark banner and github-social regain previously-clipped content (terminal-log arrows, the bottom-right "★ open source" badge). Root cause was overflow:hidden on the .banner-stage / .stage ancestors clipping the forced 1280px target during extraction. - Banner right-column status changes from per-agent token counts (12,847t / 8,402t / 3,914t) to action labels (design / impl / parallel / review). The numbers were illustrative but conflicted with how totalTokenUsage actually aggregates — both input+output, including the coordinator's decompose+synthesize passes, with same-name agents merged.
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
1 participant
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
Refresh the README to tighten positioning, add brand assets, and reorder sections. Highlights:
.github/brand/vs. Mastracomparison anchored on Supervisor vs Coordinator architectureNotes
Independent of #174. Once #174 (streaming reasoning events) lands, a small follow-up will re-add the "with reasoning events" qualifier to the streaming bullet.
Test plan
#支持的-providerjumps correctly