Merge tutorial README into root README

[puja-trivedi]

Move usage documentation (CLI, Python API, known issues) from tutorial/readme.md into the root README.md and delete the tutorial copy. Closes task 1 of #69.

[gemini-code-assist]

Summary of Changes

Hello @puja-trivedi, 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 streamlines the project's documentation by centralizing key usage instructions and known issues within the main README.md file. This change improves the discoverability and accessibility of essential information for users, eliminating the need to navigate to a separate tutorial README.

Highlights

• Documentation Consolidation: The usage documentation, including CLI and Python API instructions, and known issues, has been moved from tutorial/readme.md to the main README.md for easier access.
• File Removal: The tutorial/readme.md file has been deleted after its content was successfully integrated into the root README.md.

🧠 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.

Changelog

• README.md
  • Added sections for "Tutorials", "Using StructSense (CLI and Python)", and "Known Issues".
  • Integrated detailed instructions for CLI and Python programmatic usage.
  • Included troubleshooting and performance trade-off information.
• tutorial/readme.md
  • Removed the file as its content was migrated to the root 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. ↩

[gemini-code-assist]

Code Review

This pull request successfully merges the usage documentation from tutorial/readme.md into the root README.md, centralizing important information for users. The changes are well-structured. I've added a couple of suggestions to improve the clarity of the 'Known Issues' section, making it easier for users to diagnose and resolve common problems. Specifically, I've recommended reformatting two of the issues to clearly distinguish symptoms from their resolutions.

[tekrajchhetri]

@puja-trivedi this can be merged.

[djarecka]

I understand that this is mostly moving the content from the tutorial to the main README.

I think there still should be somewhere discussion of how to create the config file, it might be pointer to the description from the config_template.

I believe this should be also part of the tutorial (not in this PR)

[tekrajchhetri]

I understand that this is mostly moving the content from the tutorial to the main README.

I think there still should be somewhere discussion of how to create the config file, it might be pointer to the description from the config_template.

I believe this should be also part of the tutorial (not in this PR)

@puja-trivedi can already update the readme to point to the config template in this readme, which already describes the how to create config files.