Add AI best practices and Crossword Companion docs #12853
Conversation
Summary of ChangesHello @csells, 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 integrates new, detailed documentation on AI best practices for Flutter applications. The content, which covers essential aspects like effective prompting, managing structured input/output, implementing tool calls, and optimizing developer experience with AI, was efficiently generated using an innovative automation tool. This update aims to provide Flutter developers with robust guidance for building reliable and high-quality AI-powered features. Highlights
🧠 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. Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This PR adds a comprehensive set of documents on "AI Best Practices" for Flutter development, which is a great addition. The content is well-structured and covers important topics from prompting to developer experience. The automated generation of this content from a Google Doc is impressive. I've found a few typos, formatting issues, and a couple of errors in the Dart code snippets across the new markdown files. While the PR checklist mentions adherence to semantic line breaks, many lines in the new documentation exceed the 80-character limit. Addressing these points will improve the clarity and correctness of the documentation. The update to README.md is clear and helpful.
|
Visit the preview URL for this PR (updated for commit bdbe64e): https://flutter-docs-prod--pr12853-ai-best-practices-q99zuata.web.app |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/gemini review the updated content |
There was a problem hiding this comment.
Code Review
This PR adds a comprehensive set of documents on "AI Best Practices" for Flutter development. The content is well-structured and covers important topics from prompting to developer experience. The automated generation of this content from a Google Doc is impressive.
My review focuses on improving clarity, fixing typos, and ensuring consistency with the project's style guidelines. I've noticed a few areas for improvement:
- Semantic Line Breaks: The PR description states adherence to semantic line breaks of 80 characters or fewer, but many paragraphs in the new markdown files exceed this limit. I've added a comment with an example, but this applies to most of the new documentation pages.
- Code Snippets: Some Dart code snippets contain
...which is not valid syntax. These should be replaced with// ...to indicate omitted code. - Consistency: There are minor inconsistencies like trailing newlines in files and capitalization in prompt examples.
Overall, this is a great addition to the Flutter documentation. The suggested changes are mostly minor and aim to polish the content for a better reader experience.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
sfshaza2
changed the title
There was a problem hiding this comment.
Mostly lgtm, but I have a couple concerns. @parlough, please weigh in:
-
The text in these new docs use "curly" or "fancy" single- and double-quotes but we mostly use regular single- and double-quotes on the website. (I use "vi" to edit website docs, which can cause matching fails since I'm searching for regular single- and double-quotes.)
-
The top-level directory for these docs is
ai-best-practices. This seems a little counter-intuitive to me, especially as the primary reason for these pages is to document Crossword Companion. Also, this makes three top-level AI-related directories:ai,ai-toolkit, andai-best-practices. That seems rather top-heavy to me, AI-wise.
3 participants
This PR provides new "AI Best Practices" docs to the Flutter docs in the "AI solutions" section of the site.
It's also the first real-world test of a proof-of-concept "shamsify" tool that used the markdown content downloaded from a Google Doc (the original Flutter AI Best Practices doc) to produce 100% of the content for this PR, including the following:
crossword-app-main-screen.pnginstead ofimage1.png){{site.github}},{{site.pub-pkg}}, etc.javascript→dart**NOTE:**blocks to:::notesyntax<ol>/<li>\!→!,\_→_,\[→[, etc.)The work would previously have taken 6+ hours of concentrated, error-prone, detail-oriented manual human labor.
The tool executed the transformation from the source doc in 3m 4.98s:
Presubmit checklist
of 80 characters or fewer.