awslabs / awslabs/cli-agent-orchestrator
[Feat] Improve Repository Presentation and Developer Experience
- Dominant language
- Python
- Stars
- 1.3k
- Forks
- 267
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 70
Description
**Title:** `[meta] Improve repository showcase: demo, badges, examples, and discoverability`
---
## Problem
> **Related:** #469 (README restructuring, closed) and #588 (examples suite, in progress). This issue covers the visual/branding layer that complements both: logo, demo recording, badges, social proof, and use-case framing. These are adoption-conversion concerns, not docs structure or example code.
CAO has strong fundamentals (docs site, CONTRIBUTING.md, SECURITY.md, CODEBASE.md, examples/, Docusaurus), and #469 already restructured the README as a concise first-run guide. But visitors landing on the GitHub page still cannot immediately *see* what CAO does. Top-tier OSS repos in the same space (CrewAI at 57K stars, OpenHands at 84K stars, uv at 89K stars) convert visitors into users within 3 seconds through visual demos, badge density, and polished first-impression elements.
CAO currently has 1.1K stars and 222 forks. The README is informative but text-heavy and lacks the visual hooks that drive adoption at scale.
## Research: What Top Repos Do
| Element | CrewAI (57K⭐) | OpenHands (84K⭐) | uv (89K⭐) | CAO (1.1K⭐) |
|---------|---------------|-------------------|-----------|-------------|
| Project logo | ✅ Polished banner | ✅ Logo + tagline | ✅ "Made by Astral" wordmark | ❌ None |
| Hero image/GIF | ✅ Banner + video thumbnails | ✅ Screenshot preview | ✅ Benchmark bar chart | ❌ None |
| Badge row | ✅ Stars, forks, issues, PRs, license, PyPI, Twitter | ✅ CI, npm, docs, Slack | ✅ PyPI, Python versions, Discord | ⚠️ PyPI + Python only |
| Terminal demo | ✅ YouTube quickstart | ✅ npm one-liner + Docker | ✅ Animated benchmark | ❌ Text-only install |
| One-command quickstart | ✅ `crewai create crew ` | ✅ `npm install -g ... && agent-canvas` | ✅ `curl ... \| sh` | ⚠️ Long `uv tool install git+...` |
| Feature matrix (table) | ✅ "What" table | ✅ Feature grid with links | ❌ Bullet list | ❌ Bullet list |
| Community links | ✅ Forum, blog, courses | ✅ Slack, docs | ✅ Discord | ❌ None (Discussions exists but not linked) |
| Social proof | ✅ Trendshift badge, "100K certified" | ✅ "Beta" badge, star count | ✅ "Made by Astral" | ❌ None |
| Star history | ❌ | ❌ | ❌ | ❌ |
| FAQ section | ✅ 15+ Q&A | ❌ | ❌ | ❌ |
| i18n README | ❌ | ❌ | ❌ | ✅ zh-CN |
## Proposal: Phased Improvements
### Phase 1 — First Impression
1. **Finalize and add project logo** — CAO currently has no logo/mark in the README header. We need to:
- Finalize the logo design (mark + wordmark)
- Add it as an SVG to the repo (e.g. `docs/assets/cao-logo.svg`)
- Place it at the top of the README as the hero image, before badges
- Every top repo (CrewAI, OpenHands, uv) leads with a polished logo — it's the single strongest brand signal
2. **Terminal demo GIF** — Record a 30-45 second `vhs` or `asciinema` session showing:
- `cao chat` launching
- Supervisor delegating to two workers in parallel
- Workers completing tasks and reporting back
- Place above the fold in README
2. **Expanded badge row** — Add:
- CI status badge (GitHub Actions)
- License badge (Apache-2.0)
- GitHub stars badge
- Discord/community badge (if community channel exists or is created)
- Downloads badge (PyPI/month)
3. **One-line quickstart block** — Simplify the install + first-run to a single fenced block:
```bash
uv tool install cli-agent-orchestrator && cao chat
```
4. **Link GitHub Discussions** in README — Add a "Community" section pointing to the existing Discussions tab
### Phase 2 — Depth and Trust
5. **Feature comparison table** — Visual grid showing CAO vs running agents manually:
- Parallel delegation ✅
- Session isolation ✅
- Multi-provider support ✅
- Memory/learning ✅
- Web UI ✅
- Flows/workflows ✅
6. **Architecture diagram upgrade** — Replace any ASCII/text diagrams with a rendered SVG showing supervisor → workers → providers
7. **"Who uses this" or use-case section** — Even 3-4 sentence use-case descriptions:
- "Code review across multiple repos"
- "Parallel refactoring with specialist agents"
- "Automated QA pipeline"
8. **Star history embed** — Add `star-history.com` chart in README or a `/docs` page
### Phase 2.5 — Social Proof
9. **"What people build with CAO" section** — Add a use-case block to the README showing concrete scenarios (not requiring permission from anyone):
```markdown
## What people build with CAO
- 🔄 **Parallel code review** — supervisor delegates file-level reviews to specialist agents
- 🏗️ **Multi-repo refactoring** — coordinate changes across dependent repositories
- 🧪 **Automated QA pipelines** — test generation, execution, and triage in parallel
- 📝 **Documentation generation** — agents analyze code and produce docs concurrently
- 🔍 **Security auditing** — multiple agents scan different vulnerability classes simultaneously
```
10. **"Testimonials wanted" call-to-action** — Add a pinned Discussion or a section in CONTRIBUTING.md inviting users to share their experience:
```markdown
## Share your story
Using CAO in your workflow? We'd love to hear about it!
Open a thread in [Discussions](https://github.com/awslabs/cli-agent-orchestrator/discussions)
with the tag `show-and-tell` — we may feature it in the README.
```
As stories accumulate, promote the best ones to a "Built with CAO" section in the README with quotes and links.
### Phase 3 — Community Growth (ongoing)
11. **`good first issue` and `help wanted` label curation** — Audit open issues, tag 5-10 as entry points for new contributors
12. **Roadmap** — Public GitHub Project board or `ROADMAP.md` showing upcoming features (Profile Studio, plugin ecosystem, etc.)
13. **Blog post or video walkthrough** — A 5-minute "getting started" video on YouTube, linked from README
14. **Discord or community channel** — Consider a public Discord/Slack for real-time community support
15. **Graduate testimonials to "Built with CAO"** — Once 3+ real stories exist in Discussions, curate the best into a README section with developer quotes and project links
## Acceptance Criteria
- [ ] README has a finalized project logo (SVG) at the top
- [ ] README has a terminal demo (GIF or SVG animation) below the logo
- [ ] Badge row includes at minimum: PyPI version, Python versions, CI status, license, stars
- [ ] One-command quickstart block is ≤ 2 lines
- [ ] GitHub Discussions is linked from README
- [ ] Feature table or grid is present
- [ ] Architecture diagram is a rendered image (SVG/PNG), not text
- [ ] "What people build with CAO" use-case section exists in README
- [ ] Pinned Discussion or CONTRIBUTING section invites user stories (testimonials CTA)
## Ready-to-Use Badge Row
```markdown
[](https://pypi.org/project/cli-agent-orchestrator/)
[](https://pypi.org/project/cli-agent-orchestrator/)
[](https://github.com/awslabs/cli-agent-orchestrator/actions/workflows/ci.yml)
[](https://github.com/awslabs/cli-agent-orchestrator/blob/main/LICENSE)
[](https://github.com/awslabs/cli-agent-orchestrator/stargazers)
[](https://pypi.org/project/cli-agent-orchestrator/)
[](https://github.com/awslabs/cli-agent-orchestrator/discussions)
```
## References
- CrewAI README: https://github.com/crewAIInc/crewAI
- OpenHands README: https://github.com/All-Hands-AI/OpenHands
- uv README: https://github.com/astral-sh/uv
- Pydantic AI README: https://github.com/pydantic/pydantic-ai
- vhs (terminal GIF tool): https://github.com/charmbracelet/vhs
- star-history: https://star-history.com
## Labels
`documentation`, `enhancement`, `good first issue` (sub-tasks)
Contributor guide
Research direction
Start by reviewing README, CONTRIBUTING.md, the existing docs/ site, and examples/ to map the current presentation. Use the proposed docs/assets/cao-logo.svg location and the acceptance criteria to organize the logo, demo, badges, quickstart, community, feature, architecture, and use-case updates. Done means every listed README and community criterion is satisfied and the resulting presentation is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- content, design, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100