Add screenshot and comprehensive usage docs to README

[VdustR]

Summary

• Add tree view screenshot using raw.githubusercontent.com absolute URL for Marketplace compatibility
• Add comprehensive Usage section: tree view structure, context menu actions, view title actions, open behavior modes, current indicator
• Add full Commands reference split into Command Palette and Context Menu Only sections
• Add template customization summary with link to detailed guide
• Add Empty States spec link (previously missing)
• Add Documentation Maintenance rule to CLAUDE.md requiring README/docs/specs sync on feature changes

Test plan

• Verify screenshot renders on GitHub README page
• Verify all documentation links resolve correctly
• Cross-check Commands section against package.json registered commands
• Verify CLAUDE.md rule is picked up by AI assistants

🤖 Generated with Claude Code

[gemini-code-assist]

Summary of Changes

Hello @VdustR, 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 significantly enhances the user-facing documentation for the Git WorkGrove extension. It aims to provide a more complete and accessible guide for users to understand and utilize the extension's features, while also establishing internal guidelines for maintaining documentation consistency.

Highlights

• Documentation Enhancement: Added a new screenshot and comprehensive usage documentation to the README.md file, covering tree view structure, context menu actions, view title actions, open behavior modes, and current indicator.
• Command Reference: Included a full reference for all available commands, categorized by Command Palette and Context Menu Only sections.
• Template Customization: Provided a summary of template customization options with a link to the detailed guide.
• Documentation Standards: Introduced a new 'Documentation Maintenance' rule in CLAUDE.md to ensure README.md, user docs, and specs remain synchronized with code changes.
• Empty States Specification: Added a previously missing link to the 'Empty States' design specification.

🧠 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

• .changeset/add-readme-usage-docs.md
  • Added a new changeset file for the documentation update.
• CLAUDE.md
  • Introduced a new section 'Documentation Maintenance' outlining rules for keeping README.md, docs/templates.md, and docs/spec/*.md in sync with code changes.
• README.md
  • Inserted a screenshot of the Git WorkGrove tree view.
  • Added a detailed 'Usage' section explaining the tree view, context menu, view title actions, open behavior, and current indicator.
  • Expanded the 'Settings' section to include a link to template customization.
  • Created a new 'Commands' section, listing all available commands and their access methods.
  • Linked to the 'Empty States' design specification.

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 by adding a screenshot and comprehensive usage, settings, and commands sections to the README.md. It also introduces a documentation maintenance rule in CLAUDE.md to ensure docs stay in sync with code changes. The new documentation is well-structured and very helpful. I've provided a couple of minor suggestions for the README.md to improve consistency and clarity for the end-user.