Skip to content

docs: redesign README with logos, capability matrix, and marketing hero snippets - #10

Merged
huangjeff5 merged 1 commit into
mainfrom
jh-update-readme
Aug 7, 2026
Merged

docs: redesign README with logos, capability matrix, and marketing hero snippets#10
huangjeff5 merged 1 commit into
mainfrom
jh-update-readme

Conversation

@huangjeff5

Copy link
Copy Markdown
Collaborator

Description

Redesigns README.md to align with the main Genkit repository layout, branding, logos, capability matrix, and developer onboarding experience.

Key Changes

  • Branding & Header: Added official light/dark mode logo banners (docs/resources/) and quick link badges.
  • 4 Core Feature Snippets:
    1. Streaming Generation (ai.generate_stream)
    2. Streaming Tool Calling & Structured Output (WeatherInput, ActivityPlan)
    3. Tool Approval Middleware & Restarts (ToolApproval, chat.resume)
    4. Agent Loops & Persistent Sessions (ai.define_agent, chat.send)
  • Key Capabilities Matrix: HTML feature table matching the main repository.
  • Dev Tools Section: Visual preview of the Genkit Developer UI (readme-ui-traces-screenshot.png).
  • Streamlined Onboarding & Exploration: Simplified directory guide to real-world samples in samples/ and clean local dev instructions (just lint, just test).
  • Community Links: Added Twitter/X, Reddit, Discord, and GitHub issue links.

@huangjeff5
huangjeff5 force-pushed the jh-update-readme branch 3 times, most recently from 004d143 to 88687f6 Compare August 7, 2026 17:54
@huangjeff5
huangjeff5 merged commit 7a2e18c into main Aug 7, 2026
18 checks passed
@huangjeff5
huangjeff5 deleted the jh-update-readme branch August 7, 2026 18: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