docs: rework README hero to lead with BYOK + OAuth framing#1055
Conversation
Lead the README hero with the open-source alternative framing and
BYOK + ChatGPT OAuth proposition. The previous hero ("AI agent that
works out of the box") and the OpenCode-Zen-free-plan pitch were
optimized for non-technical Chinese-channel users; they soften the
hook for the English audience (Codex / Claude Cowork users with paid
plans or developer-grade BYOK habits).
Also correct the comparison target from Claude Desktop (the chat app)
to Claude Cowork (Anthropic's 2026-04 GA desktop agent that is the
actual same-category competitor in 2026).
Keep the OpenCode Zen free-plan pitch in 'Less setup' and 'Models,
Plans, and Search' so that non-technical readers still find an
on-ramp; only the hero is reframed.
README_CN.md keeps the existing Chinese-friendly framing (open-box +
OpenCode Zen free plan); only fixes the same Claude Desktop ->
Claude Cowork factual error.
Cover image alt text follows the new hero.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis pull request updates product positioning messaging across documentation and labeler configuration. The English and Chinese README introductions are refreshed to emphasize PawWork as a Claude Cowork alternative supporting any model with a bring-your-own-key approach, and the GitHub labeler configuration is expanded to track changes to these README files. ChangesProduct Positioning Refresh
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the English and Chinese README files to position PawWork as an open-source alternative to Codex App and Claude Cowork, highlighting features like bringing your own API key and ChatGPT OAuth support. The review feedback suggests improving the English grammar in the tagline and clarifying the distinction between using ChatGPT Plus/Pro plans via OAuth versus bringing an OpenAI API key.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
pr-triage requires every PR to carry one of app / ui / platform / harness / ci routing labels, but the labeler rules only watched package paths. README.md and README_CN.md are product-facing documentation for the app shell, so they belong to the app routing label rather than ci. Without this, README-only PRs fail pr-triage even when documentation + priority labels are set correctly. Adding the README files to the app rule keeps the routing semantics consistent (README pitches the app product) and removes the manual label dance for future docs-only PRs. This change rides on the README rework PR because the rework is what exposed the gap; the labeler diff is small, mechanical, and required for the rework to merge.
Two grammar / accuracy fixes from Gemini Code Assist review:
1. Hero subtitle had a comma splice that combined an imperative
clause with a 3rd-person clause that has a different subject
("Bring your own key" -> you, "works with any model" -> PawWork).
Split into two sentence fragments so the second clause reads as
a product capability (subject implicit = PawWork), matching the
first-line fragment style.
2. First paragraph said "Use your ChatGPT Plus/Pro plan for OpenAI"
which is ambiguous because the plan flows through OAuth rather
than as a direct OpenAI API key, and the line did not surface
that OpenAI direct API keys are also supported via /connect ->
Manually enter API Key. Clarify "via OAuth" and add OpenAI to
the API-key provider list.
Summary
Two changes:
approuting label so README-only PRs can satisfy the pr-triage routing-label requirement without a manual label dance.Why
For the README rework: The previous hero ("AI agent that works out of the box on your desktop") and the OpenCode-Zen-free-plan pitch optimize for non-technical Chinese-channel readers (Xiaohongshu / Zhihu). They soften the hook for the English audience that the upcoming outbound push targets: Codex App and Claude Cowork users with paid plans or developer-grade BYOK habits.
The new hero lines explicitly position PawWork against the two same-category 2026 desktop agents (Codex App, Claude Cowork) and surface BYOK + ChatGPT OAuth as the persistent value. BYOK is the main proposition; OAuth is an "including" enumeration that survives even if OpenAI later changes its OAuth policy (Anthropic already closed third-party OAuth reuse in 2026).
The OpenCode Zen free-plan pitch still appears in the "Less setup" bullet and the "Models, Plans, and Search" section, so non-technical English readers still find an on-ramp; only the hero is reframed.
README_CN.md keeps the existing Chinese-friendly framing (开箱即用 + OpenCode Zen 免费额度) because the Xiaohongshu / Zhihu audience profile matches that framing. The Chinese file only fixes the same factual error (Claude Desktop → Claude Cowork).
For the labeler fix: README.md / README_CN.md don't match any existing routing label glob (labeler only watches
packages/**paths), but pr-triage requires every PR to carry one ofapp/ui/platform/harness/ci. Without this small labeler tweak, README-only PRs fail pr-triage even whendocumentation+ priority labels are set correctly. README is product-facing documentation for the app shell, so theapprouting label is the semantically correct home.Related Issue
None. Driven by the outbound launch shaping session, not a tracked issue.
Human Review Status
Pending.
Review Focus
applabel is the right home (vsdocumentation-as-routing,ci, or a new dedicated label).Risk Notes
How To Verify
Screenshots or Recordings
Not needed. Text-only README and YAML changes; reviewers can use the PR file diff preview.
Checklist
documentation(author-applied).app(labeler will assign automatically after the labeler.yml commit lands).P3(priority-triage bot assigned).Pending.dev, and my PR title and commit messages use Conventional Commits in English.Summary by CodeRabbit