Skip to content
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

Document repo-specific prompt customization #5803

Closed
neubig opened this issue Dec 25, 2024 · 4 comments
Closed

Document repo-specific prompt customization #5803

neubig opened this issue Dec 25, 2024 · 4 comments
Labels
documentation Related to documentation enhancement New feature or request fix-me Attempt to fix this issue with OpenHands

Comments

@neubig
Copy link
Contributor

neubig commented Dec 25, 2024

What problem or use case are you trying to solve?

I believe that OpenHands supports two specific types of repo-specific prompt customization:

  1. We have the .openhands_instructions file that is used by the github resolver
  2. We have the .openhands directory, which allows for the creation of repo-specific micro-agents.

However, I believe these are not documented in the documentation site.

Describe the UX of the solution you'd like

It would be good to have these documented as a sub-folder under "Prompting" (after "Micro-Agents"):

Screenshot 2024-12-25 at 6 39 05 PM

Do you have thoughts on the technical implementation?

To implement this, it would be good to look through the entire OpenHands directory to references to the ".openhands_instructions" file and ".openhands" directory, understand exactly how they work.

Once we know the mechanisms for these two, they can be documented.

@neubig neubig added enhancement New feature or request fix-me Attempt to fix this issue with OpenHands labels Dec 25, 2024
@openhands-agent
Copy link
Contributor

OpenHands started fixing the issue! You can monitor the progress here.

@openhands-agent
Copy link
Contributor

A potential fix has been generated and a draft PR #5804 has been created. Please review the changes.

@mamoodi mamoodi added the documentation Related to documentation label Dec 26, 2024
@mamoodi
Copy link
Collaborator

mamoodi commented Dec 27, 2024

One of these is now documented: https://docs.all-hands.dev/modules/usage/prompting/customization

@mamoodi
Copy link
Collaborator

mamoodi commented Jan 6, 2025

From what I've been told the .openhands_instructions is deprecated in favor of the .openhands directory which is documented. Closing.

@mamoodi mamoodi closed this as completed Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation enhancement New feature or request fix-me Attempt to fix this issue with OpenHands
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants