docs: fix gif, readme, etc

[jpoehnelt]

No description provided.

[changeset-bot]

🦋 Changeset detected

Latest commit: c14788f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@googleworkspace/cli	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[gemini-code-assist]

Summary of Changes

Hello, 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 focuses on enhancing the project's documentation and metadata to provide a clearer and more comprehensive understanding of the gws CLI. The changes aim to improve the onboarding experience for new users, clarify authentication methods, and better articulate the tool's capabilities for both human interaction and AI agent integration.

Highlights

• Documentation Enhancement: The README.md has undergone a significant overhaul, improving clarity, structure, and detail for both new and existing users. This includes a new 'Why gws?' section, refined authentication workflows, and updated AI agent skill integration.
• Demo GIF Optimization: A new changeset entry indicates an optimization of the demo GIF, likely to improve loading times or visual quality, though the GIF itself is not part of this patch.
• Improved Discoverability: The package.json keywords have been expanded and refined to better reflect the project's scope, including specific Google Workspace services and AI agent capabilities, enhancing its discoverability.

Changelog

• .changeset/optimize-demo-gif.md
  • Added a new changeset entry for documentation and demo GIF improvements.
• README.md
  • Updated the main title and added a detailed description of the gws CLI's dynamic command surface.
  • Refactored the 'Install' section to 'Quick Start' with expanded example commands.
  • Introduced a new 'Why gws?' section explaining benefits for humans and AI agents.
  • Revised the 'Authentication' section for clarity, breaking down workflows and adding a precedence table.
  • Reorganized and updated the 'AI Agent Skills' section, including OpenClaw setup details.
  • Consolidated 'Advanced Usage' topics like Multipart Uploads and Pagination.
  • Updated the 'Model Armor (Response Sanitization)' section with clearer explanations and configuration.
  • Streamlined the 'Architecture' and 'Development' sections.
  • Removed the 'AI Agents & Skills' section, integrating its content into other parts.
  • Removed detailed usage examples that are now covered in 'Quick Start' or 'Why gws?'.
• package.json
  • Updated keywords to include more specific Google Workspace services, AI agent related terms, and oauth2, while reordering existing ones.

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 significantly improves the project's documentation, primarily by refactoring the README.md file. The new structure is much clearer, more concise, and easier for users to navigate. The updated examples and reorganized sections are excellent. I have a couple of minor suggestions to re-incorporate small but useful details from the previous version. The other changes are also positive.

_{Note: Security Review has been skipped due to the limited scope of the PR.}