-
Notifications
You must be signed in to change notification settings - Fork 4.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix issue #5803: Document repo-specific prompt customization #5804
base: main
Are you sure you want to change the base?
Conversation
|
||
## The `.openhands` Directory | ||
|
||
The `.openhands` directory allows you to create repository-specific micro-agents that extend OpenHands' capabilities for your project. These micro-agents are defined in markdown files within this directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a link to the documentation page about micro-agents.
You do not need to include any information that is already included in that documentation page, instead just refer to that page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Openhands fix success summary
The feedback has been successfully incorporated. The AI agent confirmed they simplified the .openhands
directory section by removing redundant information and adding a link to the micro-agents documentation page, which was exactly what was requested in the feedback. This avoids duplication of information while ensuring users can still access the complete details about micro-agents through the linked documentation.
The response can be sent to the reviewer as:
"The .openhands
directory section has been updated to include a link to the micro-agents documentation page, removing redundant information and ensuring users have access to the complete, up-to-date documentation about micro-agents in a single location."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Openhands fix success summary
Based on the feedback and the AI's last message, it appears the feedback has not been fully addressed. The feedback specifically requested to add a link to the micro-agents documentation page and remove redundant information, but the AI's response only mentions:
- Adding the file to the sidebar
- Updating code block formatting
There is no mention of adding the requested link to the micro-agents documentation page or removing redundant information. The AI's response seems to be addressing different changes than what was requested in the feedback.
To resolve this, the AI should explicitly confirm they have:
- Added a link to the micro-agents documentation page
- Removed any redundant information that's already covered in the micro-agents documentation
- Verified these specific changes in the repo-specific-customization.md file
Here's a concise overview of the changes and remaining issues: RESOLVED:
STILL PENDING:
RECOMMENDATION: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check if repo-specific-customization.md
is added to the sidebar within the "Prompting" directory below the "Micro-agents" section.
Overview of Changes: ✗ INCOMPLETE - Issues not fully resolved Changes Made:
Still Pending:
Recommendation: |
Fixing this issue with OpenHands seems to be blocked on resource constraints when building the site? When I run it in the online app it crashes as unresponsive. This may be fixed by being able to use larger machines. |
This pull request fixes #5803.
The issue has been successfully resolved as the AI agent has created comprehensive documentation for both repo-specific prompt customization features (.openhands_instructions file and .openhands directory) exactly as requested. The documentation was placed in the correct location (/workspace/docs/modules/usage/prompting/repo-specific-customization.md) under the "Prompting" section as specified in the original issue.
PR Review Message:
This PR adds comprehensive documentation for OpenHands' repo-specific customization features. The new documentation:
.openhands_instructions
file and.openhands
directory featuresThe documentation should help users better understand and utilize these previously undocumented features. Please review the content for accuracy and completeness.
Automatic fix generated by OpenHands 🙌
To run this PR locally, use the following command: