fix(documentation): update READMEs to match current state of repo#182
fix(documentation): update READMEs to match current state of repo#182
Conversation
- `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>
Summary of ChangesHello @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
Changelog
Activity
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
|
|
@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. |
There was a problem hiding this comment.
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.
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>
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).