docs: bullet-ize README hero; align platform README with new framing#8
Merged
mandarnilange merged 2 commits intomainfrom May 1, 2026
Merged
Conversation
Main README:
- Replace the dense paragraph after the hero with five scannable bullets
organized around the verbs that carry the pitch: Compose, Gate, Plug in,
Run anywhere, Scale.
- Tighten the trailing "domain-agnostic" line.
- Hero one-liner and "For platform teams" K8s callout unchanged.
Platform README:
- Tie the lead to the new framework story ("Run agentic workflows at
scale") and reference core as "the open framework for agentic workflows".
- Make the BYO framing explicit: bring your own LLMs, scripts, agents,
and infra; this package handles the orchestration plane.
Add a Kubernetes analogy in two places where platform engineers will expect it and the analogy is genuinely load-bearing: 1. Lead paragraph (visible on npmjs.com) — closing phrase identifies the package as the "Kubernetes-style orchestration plane underneath" with control plane + capability-scheduled workers. 2. Architecture section — one-paragraph preamble explaining the control-plane / execution-plane separation, capability-based nodeAffinity scheduling, and the deployment topology. Audience is platform teams; the analogy teaches the design rather than serving as a marketing line. Hero one-liner stays clean.
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
Two follow-up improvements after the BYO-framework messaging revamp (#7):
Main README — before / after
Before (one paragraph, 5 ideas mashed together):
After (parallel-structure bullets, each ~12–15 words):
The bold one-liner hero and the "For platform teams" K8s callout are unchanged.
Platform README — before / after
Before:
After:
Aligns with the core README so a reader landing on either npm page gets a consistent story.
What was not changed
Test plan