The issue has been successfully resolved. The original request was to create documentation about what makes good .openhands_instructions files, with the goal of helping people create high-quality instruction files. The AI agent has addressed this by:
Adding a comprehensive section to the appropriate documentation file (docs/modules/usage/how-to/github-action.md)
Including all key requested elements:
Core principles for writing instructions
Best practices for documentation
A template structure
A link to a real-world example (OpenHands' own instructions file)
Placing the documentation in a logical location within the existing docs structure
Following up on the suggestion in the thread to integrate it with the existing documentation
For a human reviewer, I would say:
"This PR adds comprehensive documentation about writing effective .openhands_instructions files, including best practices, templates, and real-world examples. The content has been integrated into the GitHub Action documentation as suggested in the issue thread. Could you please review the additions to ensure they provide clear and actionable guidance for users?"
This pull request fixes #5155.
The issue has been successfully resolved. The original request was to create documentation about what makes good
.openhands_instructionsfiles, with the goal of helping people create high-quality instruction files. The AI agent has addressed this by:docs/modules/usage/how-to/github-action.md)For a human reviewer, I would say: "This PR adds comprehensive documentation about writing effective
.openhands_instructionsfiles, including best practices, templates, and real-world examples. The content has been integrated into the GitHub Action documentation as suggested in the issue thread. Could you please review the additions to ensure they provide clear and actionable guidance for users?"Automatic fix generated by OpenHands 🙌
To run this PR locally, use the following command: