Chgill consolidate flows doc #159
Merged
+1,668
−595
Conversation
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
Restructure flows documentation to support JavaScript, Go, and Python examples. Move language-specific content into dedicated sections and add comprehensive code examples for each language. This change makes the flows documentation more accessible to developers working across different Genkit language implementations.
Remove redundant explanations and streamline language-specific sections by eliminating duplicate content about developer UI integration, deployment options, and framework philosophy across TypeScript, Go, and Python examples. Reorganize content structure for better readability and reduce repetitive descriptions.
Add comprehensive guide for using LanguageContent component in Genkit documentation. Includes best practices for minimizing duplication, maximizing common content, and proper multi-language syntax usage to create maintainable documentation.
- Replace specific `generate()` function references with generic "model generation" terminology - Remove excessive whitespace around LanguageContent blocks - Fix indentation for simplified deployment bullet point - Improve clarity by using more descriptive language for AI model interactions
Add comprehensive guidance for handling bullet lists with language-specific content. Explains spacing issues when wrapping individual bullets and provides three solutions: rewriting to be language-agnostic (preferred), wrapping entire lists, or using paragraphs instead. Updates examples to demonstrate proper patterns and includes best practices to maintain visual continuity in documentation.
- Move streaming, developer UI, and deployment features into all language sections for consistency - Fix typo in "partial" LLM responses - Improve formatting and readability of bullet points - Ensure feature parity across JavaScript, Go, and Python documentation
- Condense "Rewrite Minor Differences" section explanation - Remove duplicate bullet list examples and Option 3 paragraphs approach - Replace detailed Pattern 2 examples with section reference - Streamline content while preserving essential guidance
Add comprehensive guidelines for consistent ordering of language-specific content blocks (JavaScript, Go, Python) in documentation. Include examples of correct/incorrect usage, rationale for consistency, and update refactoring checklist to enforce proper ordering throughout the codebase.
- Replace primitive string input/output with structured types - Add MenuSuggestionInput, MenuSuggestionOutput, and FormattedMenuOutput structs - Update documentation to explain benefits of struct-based schemas - Emphasize better developer experience and future-proof API design - Ensure all Go examples follow consistent best practices
Update Python code examples in flows documentation to use structured input/output with Pydantic BaseModel classes instead of plain string parameters. This improves type safety and provides better API structure for the examples. Changes include: - Add MenuSuggestionInput, MenuSuggestionOutput, and other Pydantic models - Update function signatures to use structured input/output types - Modify function calls to use the new structured input format - Maintain consistent patterns across all flow examples
Add "Before you begin" section with initialization examples for TypeScript, Go, and Python to provide necessary context for code examples. Remove redundant pydantic BaseModel imports from Python examples.
Add missing imports (z, fmt, ai, BaseModel) to TypeScript, Go, and Python code examples in flows documentation to ensure examples are complete and functional.
…ation Restructure the flows documentation by: - Changing "Before you begin" section to "Defining and calling flows" - Integrating flow definition examples directly with initialization code - Removing duplicate code examples that were previously shown separately - Cleaning up unused imports (removed "fmt" from Go example) This makes the documentation more cohesive by showing initialization and flow definition together rather than as separate concepts.
Merge identical command examples into shared language blocks to reduce duplication and improve maintainability. Remove redundant curl examples that were repeated across language sections.
- Add comprehensive Flask deployment section for Python flows with genkit_flask_handler decorator - Include streaming support and production deployment guidance with Gunicorn - Consolidate flow calling examples into dedicated section - Reorganize deployment links into centralized "Learn more" section - Remove duplicate deployment references scattered throughout language sections
Condense the flows overview section by: - Replacing verbose examples list with concise explanation of AI workflow needs - Streamlining feature descriptions to be more scannable - Making language-specific sections more consistent and concise - Simplifying the concluding paragraph about flow architecture
Add Field import and descriptive annotations to BaseModel attributes in Python code examples throughout the flows documentation. This enhances schema documentation and makes the models more self-descriptive by providing clear field descriptions for restaurant themes, menu items, dish names, and formatted output.
Add information about using the Genkit web client library to call flows from web applications, including a reference to the client documentation page with examples of runFlow() and streamFlow() functions.
…ow items - Move "Build with AI" section after "Building AI workflows" - Reorder items in "Building AI workflows" to improve logical flow - Place "Creating flows" first as foundational concept - Group related concepts together for better user experience
Add comprehensive documentation for handling pages that only support 1 or 2 languages instead of all three (JavaScript, Go, Python). Includes required components, complete patterns, examples, and best practices for proper LanguageSelector configuration and content wrapping.
Completely rewrite LANGUAGECONTENT-GUIDE.md as a comprehensive Genkit documentation writing guide. The new guide establishes core principles (clarity, consistency, cross-linking, code samples), language-specific best practices, and technical standards for Firebase Genkit documentation across JavaScript, Go, and Python. Replaces the previous LanguageContent component usage guide with broader documentation standards covering style, formatting, cross-references, and maintainability guidelines.
Rename documentation file to better reflect its broader scope and improve clarity for contributors.
- Remove "Firebase" prefix from project name throughout documentation - Add terminology section emphasizing use of "Genkit" over "Firebase Genkit" - Enhance code examples with detailed explanations and better structure - Add comprehensive flow documentation guidelines with object-based schema patterns - Include cross-language examples for TypeScript, Go, and Python flows - Improve developer experience guidance for consistent API design
Remove all Python-specific warning messages, workarounds, and "not applicable" notices from the Dotprompt documentation. This cleanup eliminates scattered disclaimers about Python feature unavailability and alternative code patterns throughout the document.
Add note specifying that while Google GenAI package should be the default for general documentation, provider-specific documentation should use the appropriate provider's package and models (OpenAI, xAI, Anthropic, Ollama).
Remove Python-specific beta version details and streamline the semantic versioning explanation to a more general statement about following semver guidelines.
pavelgj
approved these changes
Oct 10, 2025
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.
Consolidate multi-language content in the Flows doc, align code samples, and expand Python guidance to be on par with JS and Go.