Add Roadmap and Readme Improver Microagent

[primoscope]

This PR adds a new microagent roadmap_readme_improver to the .openhands/microagents directory.

This microagent is designed to:

• Check for any improvements left on roadmap or readme files.
• Improve them by analyzing ROADMAP.md and README.md files.
• Suggest and implement improvements to these files.

The microagent does not have any specific triggers as requested.

@primoscope can click here to continue refining the PR

[gemini-code-assist]

Summary of Changes

Hello @primoscope, 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 introduces a new microagent, roadmap_readme_improver, which is dedicated to enhancing the quality of project documentation. Its core function involves reviewing and suggesting improvements for ROADMAP.md and README.md files, ensuring they are current, clear, and comprehensive. This addition aims to streamline the maintenance of accurate and useful project documentation.

Highlights

• New Microagent Introduction: A new microagent named roadmap_readme_improver has been added to the .openhands/microagents directory.
• Microagent Functionality: This microagent is designed to analyze and improve ROADMAP.md and README.md files for clarity, completeness, and accuracy.
• Trigger Mechanism: The microagent does not have specific triggers and is intended for manual invocation or general documentation improvement.

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 Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[openhands-ai]

Looks like there are a few issues preventing this PR from being merged!

• GitHub Actions are failing:
  • Build, Test and Compile

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #48 at branch `feature/roadmap-readme-improver-microagent`

Feel free to include any additional details that might help me get this PR into a better state.

_{^{You can manage your notification settings}}

[gemini-code-assist]

Code Review

This pull request introduces a new microagent, roadmap_readme_improver, designed to analyze and suggest improvements for ROADMAP.md and README.md files. The agent definition is well-structured. However, the instructions for the agent are ambiguous about which files to target when multiple ROADMAP.md or README.md files exist in the repository. I've provided suggestions to make these instructions more specific to prevent the agent from acting on incorrect files, which I consider a high-severity issue given that this file defines the agent's core behavior.

[gemini-code-assist]

The instruction to "Look for ROADMAP.md or similar files" is ambiguous. This repository contains multiple roadmap-related files (e.g., docs/planning/ROADMAP.md and ROADMAP_COMPLETE.md). This ambiguity could lead the agent to modify an incorrect file, such as a historical report instead of the active roadmap. The instruction should be more specific to guide the agent correctly.

Suggested change

	1. **Check Roadmap:** Look for `ROADMAP.md` or similar files. Identify items that might be completed but not marked, or areas where the roadmap can be clarified.
	1. **Check Roadmap:** Look for the primary `ROADMAP.md` file, typically in the root or a `docs/planning` directory, distinguishing it from archival reports. Identify items that might be completed but not marked, or areas where the roadmap can be clarified.

[gemini-code-assist]

Similarly, the instruction to "Look for README.md files" is ambiguous. The repository contains a main README.md in the root and another in the docs/ directory. To ensure the agent improves the main user-facing documentation, the instruction should specify targeting the root README.md file.

Suggested change

	2. **Check Readme:** Look for `README.md` files. Ensure installation instructions, usage examples, and project descriptions are up-to-date and easy to understand.
	2. **Check Readme:** Look for the main `README.md` file, usually in the project root. Ensure installation instructions, usage examples, and project descriptions are up-to-date and easy to understand.