Skip to content

docs(readme): video demo + restructure hero and prompt-to-production flow#612

Merged
santoshkumarradha merged 8 commits into
mainfrom
readme/hero-and-video
Jun 2, 2026
Merged

docs(readme): video demo + restructure hero and prompt-to-production flow#612
santoshkumarradha merged 8 commits into
mainfrom
readme/hero-and-video

Conversation

@santoshkumarradha
Copy link
Copy Markdown
Member

Summary

Replace the static hero image with an embedded video demo, simplify the heading, and restructure the top of the README so the install path is the first thing developers see.

What changed

  • Hero image removed. Replaced with a GitHub user-attachment video preview (centered, with a one-line caption explaining what the demo shows).
  • Title merged. # The AI Backend# AgentField — The AI Backend (single em-dash heading instead of two stacked lines).
  • "Build it with a prompt" leads. Curl install + the /agentfield skill spec are now the first content block after the hero, not the seventh section. This is the lowest-friction onboarding path and deserves top position.
  • Code example reframed as "The DX you get". Same Python claims-processor example, now framed as evidence of DX quality with a clear one-line preamble. The "Prefer to scaffold by hand?" section is collapsed into a <details> block (Python/Go/TS/Docker variants all together).
  • Hero asset updated (assets/github hero.png) to a cinematic 21:9 typographic version. Not referenced in the README right now — saved for future use (e.g., social card, future hero swap).

Why

From the analytics:

  • 41% of README visitors are "Explorers" who skim, then leave — they need video, not paragraphs.
  • 4% are "Installers" — they need the curl command above the fold, not buried below code.
  • The video + curl-first structure serves both audiences without compromising either.

The static hero image was doing the same job as the video, but worse. Removing it saves vertical space and removes redundancy.

Test plan

  • Render the README on GitHub and confirm the video player loads inline
  • Verify the curl install command and /agentfield snippet are visible above the fold on a standard laptop screen
  • Click each UTM-tagged link to verify they still resolve to the correct page
  • Confirm the "Prefer to scaffold by hand?" details block expands cleanly

…flow

- Remove static hero image; embed GitHub-hosted video preview with caption
- Merge title into single "AgentField — The AI Backend" heading
- Lead with "Build it with a prompt" (curl install + /agentfield skill spec)
- Restructure code example as "The DX you get" section
- Collapse manual scaffolding (Python/Go/TS/Docker) into details block
- Update assets/github hero.png to cinematic 21:9 typographic version
  for future use (currently not referenced in README)
@santoshkumarradha santoshkumarradha requested review from a team and AbirAbbas as code owners June 2, 2026 17:49
santoshkumarradha and others added 7 commits June 2, 2026 14:24
…able

- Swap badge colors: muted-gold label-side (#8b7355) + dark value-side (#0c0b09)
  so white text reads cleanly. Old gold-on-white values were low contrast.
- Drop the horizontal rule after the harness banner — saves vertical space
  and lets the description flow directly under the banner.
- Replace "Is AgentField for you?" with a 6-row "How does AgentField compare?"
  table. Covers LangChain/LangGraph, CrewAI, PydanticAI/OpenAI Agents SDK,
  Temporal/workflow engines, n8n/Zapier, and custom platforms. Concise format
  sourced from docs/learn/vs-frameworks; full link points there for depth.
…oreboard

- Insert "How AgentField fits in your stack" between manual-scaffolding
  details block and What You Get section — the natural moment when readers
  ask "how is this different from LangChain?" after seeing video + install + code
- Reframe from defensive "reach for AgentField when..." into a category
  positioning + capability matrix where AgentField is the only all-● column
- Bold-● rows visually highlight unique capabilities: identity, audit,
  harness orchestration, service discovery
- Drop the old "How does AgentField compare?" section near the bottom
  (replaced by the new placement above)

Promotes the vs-frameworks comparison — currently the 4th most-clicked
README link — to a position where it serves both researchers (find it
without scrolling to the bottom) and installers (they hit install+code
first, scroll past if convinced).
@santoshkumarradha santoshkumarradha merged commit 99d5673 into main Jun 2, 2026
11 checks passed
@santoshkumarradha santoshkumarradha deleted the readme/hero-and-video branch June 2, 2026 21:02
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