Skip to content

docs: README update#28

Merged
laggu merged 3 commits intodevelopfrom
gv-028
Feb 19, 2026
Merged

docs: README update#28
laggu merged 3 commits intodevelopfrom
gv-028

Conversation

@laggu
Copy link
Owner

@laggu laggu commented Feb 19, 2026

Description

  • Added documentation for global commands (add/edit/remove/list)
  • Added @global/ prefix usage\n- Documented CLI flags (--dry-run, --relative, etc.)
  • Added directory support in copy mode\n- Updated safety features description
  • Applied changes to all 8 translations (ko, ja, zh, es, pt, fr, de, it)

- Remove SilenceErrors: true from root command so Cobra prints errors
- Isolate dryRun flag: syncDryRun for sync, unsyncDryRun for unsync
- Add regression tests for error visibility and dry-run isolation

Closes #26
- Added documentation for global commands (add/edit/remove/list)
- Added @global/ prefix usage
- Documented CLI flags (--dry-run, --relative, etc.)
- Added directory support in copy mode
- Updated safety features description
- Applied changes to all 8 translations (ko, ja, zh, es, pt, fr, de, it)
@gemini-code-assist
Copy link

Summary of Changes

Hello @laggu, 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 updates the project's documentation to align with the new features introduced in version 0.25. It provides clear guidance on using global commands, leveraging the @global/ prefix for shared files, understanding various command-line interface options, and utilizing directory support within copy mode. The update also refines the descriptions of the project's safety mechanisms, ensuring users have the most current and accurate information.

Highlights

  • Global Commands Documentation: Added comprehensive documentation for new global commands including add, edit, remove, and list.
  • @global/ Prefix Usage: Documented the usage of the @global/ prefix for referencing files in global storage.
  • CLI Flags Documentation: Included detailed explanations for various CLI flags such as --dry-run and --relative.
  • Directory Support in Copy Mode: Updated documentation to reflect support for copying entire directories in copy mode.
  • Safety Features Refinement: Enhanced the descriptions of existing safety features and added new ones like 'Path Traversal Prevention'.
  • Multi-language Documentation Update: Applied all documentation changes across 8 different language translations of the README.

🧠 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
    • Updated the commands table to include new global commands and the version command.
    • Added examples for mounting from global storage and demonstrating directory copy mode.
    • Introduced a new section detailing 'Global Storage' functionality and usage.
    • Added a dedicated 'CLI Options' section explaining various command-line flags.
    • Expanded and clarified the 'Safety Features' section with new items and improved descriptions.
  • cmd/root.go
    • Removed the SilenceErrors: true setting from the root Cobra command.
  • cmd/sync.go
    • Renamed the dryRun boolean variable to syncDryRun for better scope clarity.
  • cmd/unsync.go
    • Introduced a new unsyncDryRun boolean variable for the unsync command's dry-run flag.
  • docs/translations/README_de.md
    • Updated the German translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_es.md
    • Updated the Spanish translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_fr.md
    • Updated the French translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_it.md
    • Updated the Italian translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_ja.md
    • Updated the Japanese translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_ko.md
    • Updated the Korean translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_pt.md
    • Updated the Portuguese translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • docs/translations/README_zh.md
    • Updated the Chinese translation of the README to reflect new commands, global storage, CLI options, and refined safety features.
  • test/integration.sh
    • Added new integration tests to verify error visibility for unknown flags.
    • Implemented new integration tests to confirm the isolation and functionality of sync --dry-run.
    • Added new integration tests to confirm the isolation and functionality of unsync --dry-run.
Activity
  • The pull request was created by laggu to update the documentation for git-volume to cover features introduced in version 0.25.
  • The changes address issue docs: README update #28, which likely requested comprehensive documentation for the new functionalities.
  • Documentation updates were applied to the main README.md and its eight translated versions, ensuring consistency across languages.
  • Minor code adjustments were made in cmd/root.go, cmd/sync.go, and cmd/unsync.go to improve flag handling and error reporting.
  • New integration tests were added to validate the behavior of dry-run flags and error visibility, enhancing test coverage.
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.

Copy link

@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 documentation for new features, including for all translations. The code changes include an important bug fix for the --dry-run flag which was previously shared between commands, and an improvement to error visibility, both of which are supported by new integration tests. The changes are solid, but I've noticed a minor copy-paste error in the navigation headers of some translated README files.

@laggu laggu changed the title docs: comprehensive README update for v0.25 features docs: README update Feb 19, 2026
@laggu laggu merged commit d802c14 into develop Feb 19, 2026
6 checks passed
@laggu laggu deleted the gv-028 branch February 19, 2026 04:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments