Add individual README.md to each sample

[lethargicpanda]

Add individual README.md to each sample

[gemini-code-assist]

Summary of Changes

Hello @lethargicpanda, I'm Gemini Code Assist¹! 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 introduces dedicated README.md files for all existing AI samples within the repository. The primary goal is to enhance the clarity and accessibility of each sample's documentation, providing users with a quick and thorough understanding of its purpose, how it functions, and relevant implementation details, thereby streamlining the onboarding process for new users and contributors.

Highlights

• New READMEs for AI Samples: Each sample now includes a dedicated README.md file, providing a comprehensive overview, description, "how it works" section with code snippets, and relevant documentation links.
• Enhanced Sample Documentation: The newly added READMEs significantly improve the documentation for each AI sample, making it easier for users to understand their purpose, functionality, and implementation details.
• Visual Aids and Code Snippets: Every README includes an image demonstrating the sample in action and key code snippets to highlight the core logic and interaction with AI models like Gemini and Imagen.

Ignored Files

• Ignored by pattern: .gemini/** (1)
  • .gemini/styleguide.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 👍 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. ↩

[gemini-code-assist]

Code Review

This pull request adds individual README.md files to each sample application, which is a great addition for improving the usability and understanding of each sample. The new documentation is clear and provides helpful code snippets. My review focuses on improving the maintainability of the documentation by suggesting the use of relative links, and I've also provided feedback on the code snippets to align them with Android architecture best practices and improve code robustness. Several suggestions address potential null pointer exceptions, race conditions, and violations of architectural principles.

[lethargicpanda]

cc @JolandaVerhoef @calren @ksemenova

[ksemenova]

Hoping this works. Maybe we should also add "if model version is updated in the sample make sure it's updated in the readme as well", wdyt?

[JolandaVerhoef]

WDYT about adding a separate section for the Readme? Adding it to the view model section implies that the business logic will live in that file. Instead we could say something like:

## README
 * **Strongly recommended:** Code changes to business logic should be reflected in this sample's README file. 
 * **Recommended:** When changes are made to the UI, the screenshot in this sample's README file should be updated.

[lethargicpanda]

Those are good suggestion in principle, but we should test them to see if they work.
In my (limited) testing, I wasn't able to have Gemini Code Assist specifically picking up an isolated model change and suggesting a ReadMe update.

So I will default to removing the model version from the ReadMe files for now.

[JolandaVerhoef]

nit: "Gemini API" can refer to a lot of things. Would you consider adding a reference to "cloud" here somewhere?

[lethargicpanda]

The "Gemini API" is the name of the product to enable access to Flash and Pro to developers. So I think we should keep it.