Skip to content

docs(py): audit and fix stale Python documentation#4658

Merged
yesudeep merged 1 commit intomainfrom
yesudeep/ci/releasekit-publish-workflow
Feb 13, 2026
Merged

docs(py): audit and fix stale Python documentation#4658
yesudeep merged 1 commit intomainfrom
yesudeep/ci/releasekit-publish-workflow

Conversation

@yesudeep
Copy link
Contributor

Cross-checked all markdown files in py/ against the codebase and open PRs.
Fixed outdated content across 9 files.

engdoc/index.md:

  • Fix Python version: 3.12+ → 3.10+
  • Update feature parity table (6 of 7 features now ✅, Agents still ❌)
  • Replace 8-plugin table with full 23-plugin parity table
  • Rewrite all 6 Python code examples (generation, structured output,
    tool calling, chat, agents, data retrieval) with correct imports,
    Genkit() class API, and @ai.tool() decorator pattern

engdoc/extending/api.md:

  • Replace stale Sync/Async design section (GenkitExperimental/SyncGenkit/
    AsyncGenkit never implemented) with actual async-first architecture
    documenting GenkitRegistry → GenkitBase → Genkit hierarchy

engdoc/extending/index.md:

  • Update d2 diagram plugin list from 7 to 22 plugins

engdoc/extending/servers.md:

  • Fill Python TODO links with actual file paths (flows.py, reflection.py)

engdoc/user_guide/python/publishing_pypi.md:

  • Add ReleaseKit as primary publishing mechanism
  • Demote manual workflow to "Legacy" section

GEMINI.md:

  • Remove 7 dangling references to deleted files (engdoc/planning/,
    blog-genkit-python-*.md, release-publishing-guide.md)
  • Update blog article guidelines from mandatory to optional
  • Remove stale validation script checking deleted paths

.github/PR_RELEASE.md:

  • Remove dangling reference to deleted blog-genkit-python-0.5.0.md

PARITY_AUDIT.md:

@github-actions github-actions bot added docs Improvements or additions to documentation python Python ci config labels Feb 13, 2026
@yesudeep yesudeep enabled auto-merge (squash) February 13, 2026 21:25
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @yesudeep, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request comprehensively audits and updates the Python SDK documentation, ensuring its accuracy and alignment with the current codebase. It addresses outdated information regarding Python version compatibility, feature parity, API architecture, and publishing workflows, while also removing numerous deprecated planning and analysis documents. The changes aim to provide clearer, more relevant guidance for Python developers using the SDK.

Highlights

  • Python Version & Feature Parity Updates: The minimum Python version requirement was updated from 3.12+ to 3.10+, and feature parity tables were refreshed to reflect expanded Python SDK capabilities, including a new 23-plugin table and updated agent status.
  • API Architecture & Code Example Revisions: Outdated Sync/Async API design documentation was replaced with an async-first architecture, and Python code examples for generation, structured output, tool calling, chat, agents, and data retrieval were rewritten to align with current API patterns.
  • Documentation Cleanup & Consolidation: Numerous stale planning documents, blog articles, and parity analyses were removed, streamlining the documentation. Plugin lists in diagrams were expanded, and Python TODO links in server documentation were resolved.
  • PyPI Publishing Workflow Enhancement: ReleaseKit was promoted as the primary PyPI publishing mechanism, with the previous manual workflow demoted to a legacy option, reflecting an automated and robust release process.
  • Parity Audit Status Corrections: The PARITY_AUDIT.md file was updated with various status corrections, including marking G7 as reverted, confirming X-Genkit-Span-Id sending as fixed, updating Cohere plugin status, and noting several roadmap items as closed or superseded.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • py/.github/PR_RELEASE.md
    • Removed the 'Blog Article' section, including a dangling reference to a deleted blog post.
  • py/GEMINI.md
    • Removed references to old planning documents and blog articles.
    • Updated blog article guidelines from mandatory to optional.
    • Removed a stale validation script check.
  • py/PARITY_AUDIT.md
    • Updated the audit date.
    • Added Cohere and FastAPI plugins to the parity matrix and adjusted total plugin counts.
    • Marked G7 as reverted and updated G6->G5 as fixed.
    • Noted G2->G1 as superseded and updated statuses for several paused roadmap items (G3, G12-G16, G4) to reflect their closure and need for new PRs.
  • py/engdoc/ROADMAP.org
    • Removed the SDK roadmap document.
  • py/engdoc/blog-genkit-python-0.5.0.md
    • Removed the blog article for Genkit Python SDK 0.5.0.
  • py/engdoc/extending/api.md
    • Replaced the 'Sync vs Async Design' section with a detailed 'Async-First Design' explanation.
    • Updated class hierarchy diagrams (ASCII and Mermaid) to reflect the async-first architecture.
  • py/engdoc/extending/index.md
    • Updated the d2 diagram to reflect an expanded list of 22 plugins, removing older entries like Chroma and Pinecone and adding new ones.
  • py/engdoc/extending/servers.md
    • Replaced placeholder TODO links for Python flows and reflection server sources with actual file paths.
  • py/engdoc/index.md
    • Changed the minimum Python version requirement from 3.12+ to 3.10+.
    • Updated the feature parity table to show Python support for chat, data retrieval, generation, prompt templating, structured output, and tool calling.
    • Expanded the plugin parity table to include 23 plugins.
    • Rewrote all Python code examples to use the Genkit() class API and @ai.tool() decorator.
  • py/engdoc/model-conformance-roadmap.md
    • Removed the model conformance testing plan document.
  • py/engdoc/parity-analysis/feature_parity_analysis.md
    • Removed the Genkit feature parity analysis document.
  • py/engdoc/parity-analysis/model_spec_compliance.md
    • Removed the model spec compliance analysis document.
  • py/engdoc/parity-analysis/plugin_api_consistency.md
    • Removed the plugin API consistency report document.
  • py/engdoc/parity-analysis/sample_parity_roadmap.md
    • Removed the sample parity analysis and roadmap document.
  • py/engdoc/planning/FEATURE_MATRIX.md
    • Removed the plugin feasibility and feature matrix document.
  • py/engdoc/planning/README.md
    • Removed the plugin implementation plans summary document.
  • py/engdoc/planning/azure-telemetry-plugin.md
    • Removed the Azure telemetry plugin implementation plan.
  • py/engdoc/planning/cloudflare-ai-plugin.md
    • Removed the Cloudflare Workers AI plugin implementation plan.
  • py/engdoc/planning/cloudflare-telemetry-plugin.md
    • Removed the Cloudflare telemetry plugin implementation plan.
  • py/engdoc/planning/observability-plugin.md
    • Removed the observability plugin implementation plan.
  • py/engdoc/planning/vercel-plugins.md
    • Removed the Vercel plugins implementation plan.
  • py/engdoc/release-publishing-guide.md
    • Removed the Python SDK release and publishing guide.
  • py/engdoc/user_guide/python/publishing_pypi.md
    • Updated the document to introduce ReleaseKit as the primary publishing mechanism.
    • Reclassified the previous manual workflow as a 'Legacy' fallback.
  • py/plugins/README.md
    • Removed outdated references to plugin planning and feature matrix documents.
  • py/tools/conform/ANNOUNCEMENT.md
    • Removed the announcement document for the Conform tool.
  • py/tools/conform/README.md
    • Updated the directory structure to include __main__.py and clarified the config loader description.
    • Added new configuration options for action, health, and startup timeouts.
    • Introduced per-model overrides for action-timeout.
  • py/tools/releasekit/ANNOUNCEMENT.md
    • Removed the announcement document for ReleaseKit.
  • py/tools/releasekit/FIXES.md
    • Removed the Releasekit audit fixes roadmap document.
  • py/tools/releasekit/README.md
    • Updated the feature matrix to mark SBOM, Plan profiling, and OpenTelemetry tracing as implemented.
    • Revised the configuration example to reflect the new releasekit.toml structure with forge, repo_owner, repo_name, default_branch, pr_title_template, and workspace.py specific settings.
    • Added doctor subcommand to the CLI table.
  • py/tools/releasekit/docs/competitive-gap-analysis.md
    • Updated the internal link to the roadmap document.
  • py/tools/releasekit/docs/roadmap-execution-plan.md
    • Removed the Releasekit roadmap execution plan document.
  • py/tools/releasekit/roadmap.md
    • Updated the configuration structure in releasekit.toml.
    • Reflected the implementation status of pnpm backends.
    • Updated test counts and source/test file statistics.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request provides a comprehensive audit and cleanup of the Python SDK documentation. The changes are extensive, removing numerous stale planning documents and updating existing guides to accurately reflect the current state of the codebase, including API changes, feature parity, and release processes. The updated documentation is clearer and more reliable for developers. The changes align perfectly with the pull request's description. Great work on this significant documentation overhaul!

@yesudeep yesudeep disabled auto-merge February 13, 2026 21:31
Cross-checked all markdown files in py/ against the codebase and open PRs.
Fixed outdated content across 9 files.

engdoc/index.md:
- Fix Python version: 3.12+ → 3.10+
- Update feature parity table (6 of 7 features now ✅, Agents still ❌)
- Replace 8-plugin table with full 23-plugin parity table
- Rewrite all 6 Python code examples (generation, structured output,
  tool calling, chat, agents, data retrieval) with correct imports,
  Genkit() class API, and @ai.tool() decorator pattern

engdoc/extending/api.md:
- Replace stale Sync/Async design section (GenkitExperimental/SyncGenkit/
  AsyncGenkit never implemented) with actual async-first architecture
  documenting GenkitRegistry → GenkitBase → Genkit hierarchy

engdoc/extending/index.md:
- Update d2 diagram plugin list from 7 to 22 plugins

engdoc/extending/servers.md:
- Fill Python TODO links with actual file paths (flows.py, reflection.py)

engdoc/user_guide/python/publishing_pypi.md:
- Add ReleaseKit as primary publishing mechanism
- Demote manual workflow to "Legacy" section

GEMINI.md:
- Remove 7 dangling references to deleted files (engdoc/planning/,
  blog-genkit-python-*.md, release-publishing-guide.md)
- Update blog article guidelines from mandatory to optional
- Remove stale validation script checking deleted paths

.github/PR_RELEASE.md:
- Remove dangling reference to deleted blog-genkit-python-0.5.0.md

PARITY_AUDIT.md:
- G7: ✅ Done → ⬜ Reverted (#4459 reverted by #4469, needs re-land)
- §8c.3/§8c.4: Update stale text — X-Genkit-Span-Id IS now sent (#4511)
- §1d: genkitx-cohere ❌ → ✅ (in-tree cohere plugin exists)
- §6c: Community coverage 3/6 → 4/6
- G17: 🔄 draft → ⬜ (#4521 closed, needs new PR)
- G3/G12-G16/G4: Note #4510 is closed, needs new PR after G38
- G2→G1: Mark as superseded (#4516 titled [SUPERSEDED])
@yesudeep yesudeep force-pushed the yesudeep/ci/releasekit-publish-workflow branch from fa670f6 to 06fc7a6 Compare February 13, 2026 21:36
@yesudeep yesudeep enabled auto-merge (squash) February 13, 2026 21:38
@yesudeep yesudeep merged commit 97f0451 into main Feb 13, 2026
29 checks passed
@yesudeep yesudeep deleted the yesudeep/ci/releasekit-publish-workflow branch February 13, 2026 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci config docs Improvements or additions to documentation python Python

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants