Skip to content

Docs: Align title and improve discoverability of "Flows" concept page #122

@LyalinDotCom

Description

@LyalinDotCom

This issue covers two key points of feedback on the documentation page for Genkit Flows, which is a critical onboarding document for new users.

1. Inconsistent Page Titles

There is a mismatch between the navigation link text and the H1 title on the page itself.

  • Navigation Link: Creating Flows
  • Page H1 Title: Defining AI workflows

For consistency across the documentation, these two titles should be aligned.

2. "Flows" Terminology May Be Unclear to New Users

While "Flows" is the core terminology within the framework, using it in the main navigation link may be confusing for a developer who is brand new to Genkit. This page's purpose is to introduce a foundational concept, but a new user won't know what a "Flow" is yet and might not click on it.

The page itself does a good job of introducing the concept by first talking about general "AI workflows" and then defining Genkit's specific implementation of them as a "Flow." The title should follow this same principle: use more generic, understandable language for discovery, and then teach the specific terminology within the page.

Recommendation:

To address both issues, we should align the navigation link and the H1 title to something more descriptive and less reliant on Genkit-specific jargon.

Suggested new title for both the nav link and the H1: "Building AI Workflows".

This title is more intuitive for a new user, accurately describes the page's content, and resolves the inconsistency. The page can then continue to explain that the way to build these workflows in Genkit is by defining a "Flow."

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions