Skip to content

Comments

fix(documentation): update READMEs to match current state of repo#182

Merged
iennae merged 3 commits intomainfrom
fix_documentation
Feb 9, 2026
Merged

fix(documentation): update READMEs to match current state of repo#182
iennae merged 3 commits intomainfrom
fix_documentation

Conversation

@iennae
Copy link
Contributor

@iennae iennae commented Feb 9, 2026

  • README.md: Completely rewritten to reflect the current repository structure. It now correctly lists the four main sample applications (HelloWorld, Bookshelf, BackgroundProcessing, and Sessions) and the Google Cloud APIs they utilize (Firestore, Cloud SQL, Cloud Storage, Pub/Sub, Translation, and KMS).
  • TESTING.md: Updated with accurate instructions for setting up and running tests. It now lists the correct APIs to enable and provides the proper command to run tests from the root directory (.\BuildAndRunTests.ps1), removing outdated references to the non-existent aspnet directory.
  • Bookshelf/README.md: Updated the title from "Binary Data" to "Bookshelf Sample" and clarified the services used (adding Cloud SQL).

   - `README.md`: Completely rewritten to reflect the current repository structure. It now correctly lists the four main sample applications (HelloWorld, Bookshelf, BackgroundProcessing, and Sessions)
     and the Google Cloud APIs they utilize (Firestore, Cloud SQL, Cloud Storage, Pub/Sub, Translation, and KMS).
   - `TESTING.md`: Updated with accurate instructions for setting up and running tests. It now lists the correct APIs to enable and provides the proper command to run tests from the root directory
     (.\BuildAndRunTests.ps1), removing outdated references to the non-existent aspnet directory.
   - `Bookshelf/README.md`: Updated the title from "Binary Data" to "Bookshelf Sample" and clarified the services used (adding Cloud SQL).

Signed-off-by: Jennifer Davis <sigje@google.com>
@iennae iennae requested a review from amanda-tarafa February 9, 2026 04:27
@iennae iennae requested a review from a team as a code owner February 9, 2026 04:27
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @iennae, 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 significantly improves the project's documentation by updating the main README.md, TESTING.md, and Bookshelf/README.md files. The changes ensure that the documentation accurately reflects the current state of the sample applications, their dependencies on Google Cloud services, and the correct procedures for setting up and running tests, thereby enhancing clarity and reducing potential confusion for users and contributors.

Highlights

  • Main README Update: The primary README.md has been completely rewritten to accurately describe the repository's current structure, listing the four main sample applications (HelloWorld, Bookshelf, BackgroundProcessing, Sessions) and the Google Cloud APIs they leverage (Firestore, Cloud SQL, Cloud Storage, Pub/Sub, Translation, KMS).
  • Testing Documentation Refinement: TESTING.md now provides precise instructions for setting up and running tests, including an explicit list of required Google Cloud APIs to enable and the correct PowerShell command (.BuildAndRunTests.ps1) to execute tests from the repository root, removing obsolete references.
  • Bookshelf README Clarification: The Bookshelf/README.md has been updated to correctly title the sample as "Bookshelf Sample" and to accurately reflect its use of Cloud SQL in addition to Firestore and Cloud Storage.
Changelog
  • Bookshelf/README.md
    • Changed the title from "# Binary Data" to "# Bookshelf Sample".
    • Updated the description to specify "ASP.NET Core" and added "Cloud SQL" to the list of used Google Cloud services.
  • README.md
    • Rewrote the introductory section to describe the repository as containing C# and ASP.NET Core samples for Google Cloud.
    • Replaced the previous library and aspnet directory descriptions with a new "Samples" section, detailing HelloWorld, Bookshelf, BackgroundProcessing, and Sessions applications.
    • Introduced a "Cloud APIs used" section, explicitly listing Cloud Firestore, Cloud SQL, Cloud Storage, Cloud Pub/Sub, Cloud Translation, and Cloud Key Management Service (KMS).
    • Removed outdated references to client libraries and the aspnet directory.
  • TESTING.md
    • Standardized terminology from "Google Cloud Platform Console" to "Google Cloud Console" and "Google Cloud Platform" to "Google Cloud".
    • Removed the instruction to select a United States location for App Engine.
    • Replaced a generic API enablement link with a specific enumerated list of APIs to enable: Cloud Firestore API, Cloud Pub/Sub API, Cloud Storage API, Cloud Translation API, Cloud SQL Admin API, and Cloud Key Management Service (KMS) API.
    • Streamlined environment variable instructions, removing ApplicationName, AuthClientId, AuthClientSecret, and ConnectionStringSqlServer.
    • Updated the list of required tools to include ".NET Core SDK" and "PowerShell", removing "MSBuild", "MSTest", and "Nuget".
    • Corrected the test execution command to .BuildAndRunTests.ps1 to be run from the repository root, removing the aspnet directory context.
Activity
  • The author, iennae, has provided a detailed description of the changes in the pull request body, outlining the updates made to README.md, TESTING.md, and Bookshelf/README.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.

@iennae
Copy link
Contributor Author

iennae commented Feb 9, 2026

@amanda-tarafa please review as the current repository documentation didn't match what is actually in this repository so it's hard to ascertain the intent without updated documentation. Thanks.

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 update to the repository's documentation, including the main README.md, Bookshelf/README.md, and TESTING.md. The changes accurately reflect the current structure and samples, removing outdated information and clarifying setup and testing procedures. The updated documentation is much clearer and more helpful for new users. I've added a couple of minor suggestions to improve formatting consistency in TESTING.md.

iennae and others added 2 commits February 8, 2026 20:29
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>
@iennae iennae added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Feb 9, 2026
@iennae iennae merged commit 5a41b93 into main Feb 9, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kokoro:force-run Add this label to force Kokoro to re-run the tests.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants