Skip to content

docs: lead with the agent value prop (README + dashboard hero rework)#19

Merged
howardpen9 merged 1 commit into
mainfrom
chore/v1.6-agent-first-hero
Jun 10, 2026
Merged

docs: lead with the agent value prop (README + dashboard hero rework)#19
howardpen9 merged 1 commit into
mainfrom
chore/v1.6-agent-first-hero

Conversation

@howardpen9

Copy link
Copy Markdown
Owner

Summary

Reorders both the README and the GitHub Pages dashboard so the first-fold = "point your AI agent here, stop hand-checking 10 relay pricing pages" — the actual value prop of this repo. Before this PR, the agent-integration section was at TOC position 10/16 (buried). The dashboard's first content block was a Plotly chart for humans; the raw URL / MCP install was in the footer.

Changes

README (en/zh-TW/zh-CN):

  • New tagline: "One pricing endpoint for AI agents."
  • Fenced code block at top with three ways to consumecurl raw JSON, uvx MCP server, open interactive dashboard
  • TOC reordered: "For AI agents" + "Price snapshot" jump to the top

Dashboard (docs/index.html):

  • New .agent-hero gradient-tinted block above the controls/charts with:
    • Copy-to-clipboard button for the raw prices.latest.json URL
    • Copy curl one-liner
    • Collapsible <details> with the Claude Desktop MCP config + uvx install
  • Visual divider 👀 For humans — explore the data below separating the agent section from the existing tier chart + heatmap + records table

Scope discipline

Presentation only. No changes to: data, schemas, fetchers, workflows, validate, build_prices. Other v1.6 polish items (risk_flags, status emoji + legend, benchmark refs, PR #9 FerryAPI triage) ship separately.

Test plan

  • All 3 READMEs render correctly (verified markdown + TOC links)
  • Dashboard loads on local file open + copy buttons work (clipboard API)
  • Verify on GH Pages once merged: https://howardpen9.github.io/awesome-ai-api-proxy/
  • Verify mobile responsive (the copy-row uses flex; long URL should overflow-scroll, not break layout)

Follow-ups (not in this PR)

  • Dashboard ["openrouter", "atlascloud", "relaydance"] hardcoded list in the heatmap render still misses uiuiapi/bltcy/unorouter — separate PR
  • risk_flags + 🟢/🟡/🔴 status emoji + legend
  • Benchmark refs (tbench / kilo / arena) — README link + canonical-models.yaml field
  • Triage PR add: FerryAPI global gateway #9 (FerryAPI) after risk_flags ships

🤖 Generated with Claude Code

The repo's actual value is being the canonical agent-readable pricing
endpoint, but readers had to scroll past 9 TOC items / past the entire
human-curated relay list before seeing it. Reorders + adds hero blocks
so first-fold = "point your agent here, stop hand-checking 10 pages".

README (en/zh-TW/zh-CN):
- Replaces "One key. Every model. Anywhere." tagline with
  "One pricing endpoint for AI agents."
- Adds a fenced code block at the top with three ways to consume:
  curl raw JSON / uvx MCP server / open dashboard
- Reorders TOC so "For AI agents" + "Price snapshot" come first

Dashboard (docs/index.html):
- New .agent-hero block above the meta/controls — gradient-tinted card
  with copy-to-clipboard buttons for the raw URL, curl one-liner, and
  Claude Desktop MCP config snippet
- Visual divider "👀 For humans — explore the data below" before the
  existing tier chart + heatmap + table

Scope kept tight: this is presentation only. No data, schema, fetcher,
or workflow changes. Other v1.6 polish items (risk_flags, status emoji,
benchmark refs, FerryAPI #9 triage) follow separately.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@howardpen9 howardpen9 marked this pull request as ready for review June 10, 2026 08:56
@howardpen9 howardpen9 merged commit e3d6fba into main Jun 10, 2026
1 check passed
@howardpen9 howardpen9 deleted the chore/v1.6-agent-first-hero branch June 10, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant