Added link to Models docs for prompt.yml files #57
+2
−0
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a direct link to GitHub Models documentation for users unfamiliar with .prompt.yml files.
- Inserts a reference link explaining
.prompt.ymlusage - Enhances README clarity around prompt files
Comments suppressed due to low confidence (1)
README.md:83
- Indent this line to match the two-space indentation of the surrounding paragraphs for consistent markdown formatting.
Learn more about `.prompt.yml` files here: [Storing prompts in GitHub repositories](https://docs.github.com/en/github-models/use-github-models/storing-prompts-in-github-repositories)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
LindseyB
approved these changes
Jun 5, 2025
cheshire137
reviewed
Jun 5, 2025
| @@ -80,6 +80,8 @@ gh models eval my_prompt.prompt.yml --json | |||
|
|
|||
| The JSON output includes detailed test results, evaluation scores, and summary statistics that can be processed by other tools or CI/CD pipelines. | |||
|
|
|||
| Learn more about `.prompt.yml` files here: [Storing prompts in GitHub repositories](https://docs.github.com/en/github-models/use-github-models/storing-prompts-in-github-repositories). | |||
There was a problem hiding this comment.
Suggestion: if we omit the /en in the URL, then if there's a non-English translation available and the user's browser requests that other language, we'll render our docs in the user's preferred language instead of defaulting them to English.
Edit: I opened #58 to drop the /en.
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.
Provides a bit of clarity for users who are unfamiliar with
.prompt.ymlfiles.