docs(readme): video demo + restructure hero and prompt-to-production flow#612
Merged
Conversation
…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)
…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).
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
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
# The AI Backend→# AgentField — The AI Backend(single em-dash heading instead of two stacked lines)./agentfieldskill 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.<details>block (Python/Go/TS/Docker variants all together).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:
The static hero image was doing the same job as the video, but worse. Removing it saves vertical space and removes redundancy.
Test plan
/agentfieldsnippet are visible above the fold on a standard laptop screen