website icon indicating copy to clipboard operation
website copied to clipboard

Refactor AI Toolkit documentation to update LLM provider references a…

Open csells opened this issue 1 month ago • 3 comments

…nd improve clarity

  • Updated references from deprecated google_generative_ai and vertexai_firebase packages to the new firebase_ai package across multiple files.
  • Enhanced descriptions and examples in the chat-client-sample.md, custom-llm-providers.md, and feature-integration.md to reflect the latest changes in the AI Toolkit.
  • Improved formatting and consistency in the documentation for better readability and user experience.

Presubmit checklist

  • [x] If you are unwilling, or unable, to sign the CLA, even for a tiny, one-word PR, please file an issue instead of a PR.
  • [x] If this PR is not meant to land until a future stable release, mark it as draft with an explanation.
  • [x] This PR follows the Google Developer Documentation Style Guidelines—for example, it doesn't use i.e. or e.g., and it avoids I and we (first-person pronouns).
  • [x] This PR uses semantic line breaks of 80 characters or fewer.

csells avatar Dec 06 '25 01:12 csells

Summary of Changes

Hello @csells, I'm Gemini Code Assist[^1]! 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 refactors the AI Toolkit documentation to align with the new firebase_ai package, replacing deprecated LLM provider references and unifying configuration instructions. It also significantly enhances clarity, improves formatting, and introduces new sections for advanced features like function calling and custom speech-to-text, ensuring the documentation accurately reflects the latest SDK changes and provides a better user experience.

Highlights

  • LLM Provider Migration: Updated all documentation references from the deprecated google_generative_ai and vertexai_firebase packages to the new firebase_ai package, ensuring consistency with the latest SDK.
  • Documentation Clarity and Formatting: Enhanced descriptions and examples across chat-client-sample.md, custom-llm-providers.md, and feature-integration.md for improved understanding and readability, alongside general formatting and consistency improvements.
  • New Feature Documentation: Added new sections in feature-integration.md detailing 'Function calling' and 'Custom speech-to-text' capabilities within the AI Toolkit.
  • Simplified Configuration: Streamlined the configuration instructions in index.md to reflect the unified firebase_ai package, removing separate setup guides for Gemini API keys and Vertex AI.
  • Enhanced User Experience Details: Updated details on multiline text input gestures for Web/Desktop and introduced an 'Attach Link' option for multimedia input in user-experience.md.
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 :thumbsup: and :thumbsdown: 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.

[^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.

gemini-code-assist[bot] avatar Dec 06 '25 01:12 gemini-code-assist[bot]

fyi: @mit-mit @sfshaza2 new draft PR with consistent branding changes to Firebase AI Logic SDK as well as a much cleaner set of files (the other PR went a little whacko on me).

csells avatar Dec 06 '25 01:12 csells

Visit the preview URL for this PR (updated for commit 1bca581e9cb02908a675039d97141fcbb8a8948b):

https://flutter-docs-prod--pr12787-ai-toolkit-updates-2-d8r32a9k.web.app

flutter-website-bot avatar Dec 06 '25 01:12 flutter-website-bot

@csells, the build is failing because ai-toolkit/custom-llm-providers/index.html doesn't exist.

sfshaza2 avatar Dec 15 '25 15:12 sfshaza2

I'm away from my computer today but custom LLM providers are discussed in the custom-llm-providers.md in the same folder. I can fix this tomorrow.

csells avatar Dec 15 '25 16:12 csells

I found the problem. The recommended:

dart run dash_site check-all

doesn't check all, e.g. it doesn't check link references. The readme doesn't say to do this, too:

dart run dash_site build
dart run dash_site check-link-references

to check references.

Reference error found and fixed.

csells avatar Dec 16 '25 18:12 csells