Documenation added

[lloc]

This adds documentation for agents and users.

[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 primarily focuses on a significant enhancement of the project's documentation. It introduces a new AGENTS.md file to provide clear and comprehensive guidelines for contributors, covering various aspects of development and contribution. Concurrently, the README.md has been substantially updated to offer more detailed information for users, including requirements, installation, usage, and troubleshooting, thereby improving the overall user experience and onboarding process. Minor internal configuration adjustments were also made.

Highlights

• Contributor Guidelines: A new AGENTS.md file has been added, providing comprehensive guidelines for project structure, development workflows, coding standards, and release processes for contributors.
• Enhanced User Documentation: The README.md file has been significantly expanded to include detailed sections on plugin requirements, installation steps, usage instructions, and troubleshooting tips, making it easier for users to get started and resolve common issues.
• Configuration Update: The .phpcs.xml.dist file was updated to correct the description of the PHPCS ruleset, changing it from MslsMenu to MslsSelect.
• Dependency Reordering: Development dependencies in composer.json were reordered for improved readability and organization, with no functional changes to the dependencies themselves.

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 includes documentation updates, a change in the phpcs configuration, and a modification to the composer.json file. The documentation updates involve adding a new AGENTS.md file and updating the README.md file with more detailed information about the plugin. The phpcs configuration change involves updating the description. The composer.json file has been modified to reorder the require-dev dependencies.