Documentation added

[lloc]

• AGENTS.md created
• README.md contains now detailed instructions

[gemini-code-assist]

Summary of Changes

Hello @lloc, 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 substantially improves the project's documentation by introducing a new AGENTS.md file dedicated to contributor guidelines and thoroughly updating the README.md. These changes aim to provide clearer instructions for both users and developers, covering everything from setup and usage to coding standards and troubleshooting, thereby enhancing the overall accessibility and maintainability of the project.

Highlights

• New Contributor Guidelines: A new AGENTS.md file has been added, detailing comprehensive repository guidelines for project structure, build and test commands, coding style, testing practices, commit and pull request expectations, and localization workflow tips.
• Enhanced README Documentation: The README.md has been significantly expanded to include detailed sections on project requirements, installation instructions, configuration specifics, a comprehensive usage guide with command examples, development commands, and a troubleshooting section for common issues.

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

The pull request adds documentation in AGENTS.md and updates README.md with detailed instructions for the project. The changes in README.md introduce sections for requirements, installation, configuration, usage, development, and troubleshooting. The AGENTS.md file provides guidelines for project structure, build commands, coding style, testing, commit practices, and localization workflow.

[gemini-code-assist]

The description could be more concise and directly state the purpose of the scripts.

Consider revising to something like: "Provides Composer scripts for WordPress i18n automation using WP-CLI."

Suggested change

	Automate the internationalization workflow of your WordPress plugin or theme by wiring WP-CLI translation tools into familiar Composer commands.
	Automates WordPress i18n workflow via Composer scripts and WP-CLI.

[gemini-code-assist]

Consider rephrasing to clarify that WP-CLI needs to be accessible system-wide.

Suggestion: "- WP-CLI 2.12+ available in your system's $PATH"

Suggested change

	- WP-CLI 2.12+ available on your `$PATH`
	- WP-CLI 2.12+ available in your system's `$PATH`

[gemini-code-assist]

Consider adding a suggestion to check file permissions if translations are not being picked up, as this is a common issue.

Suggestion: "- Translations not picking up new strings: rerun composer i18n:make-pot before updating .po files so the template is up to date. Also, ensure proper file permissions are set for the languages directory."

Suggested change

	- **“Text domain is not set”**: ensure your plugin/theme headers declare `Text Domain` and `Domain Path`.
	- **WP-CLI not found**: verify `wp` is installed globally or provide an absolute path (e.g. symlink `wp` into `/usr/local/bin`).
	- **Translations not picking up new strings**: rerun `composer i18n:make-pot` before updating `.po` files so the template is up to date.
	- **Translations not picking up new strings**: rerun `composer i18n:make-pot` before updating `.po` files so the template is up to date. Also, ensure proper file permissions are set for the languages directory.