Fix issue #4181: Prompting best practices documentation #4182
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request fixes #4181.
This PR successfully addresses the issue by adding documentation on prompting best practices and integrating it into the UI. Specifically:
Created a new file 'prompting_best_practices.md' in the docs/ folder with comprehensive guidelines on good and bad prompts for the OpenHands AI software developer.
Updated 'SettingsModal.tsx' to pass the new 'promptingBestPracticesUrl' prop to the SettingsForm component.
Modified 'SettingsForm.tsx' to:
a. Include 'promptingBestPracticesUrl' in the SettingsFormProps interface
b. Add the prop to the function parameters
c. Implement a new div with a link to the Prompting Best Practices document
These changes not only provide the requested documentation but also make it easily accessible to users through the settings modal in the frontend interface.
Automatic fix generated by OpenHands 🙌