feat: show README for prompts when available #313
Merged
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 actually fixes: #270
TLDR; many of the prompts are committed by a different person, not the author. In such cases, the author is usually credited in the README, but with no link, to their github account or no mention of the github username.
So in such cases, to avoid misattributing the prompt we can show a link to the readme instead. This can also be understood as a feature, to get help with the prompt
I also added a script (& readme for it) to update the JSON, and I also created this repo: to store the prompts and the python script that creates the JSON in the first place. This way, adding new prompts is still a manual process, but a quite simple one.
https://github.com/stacklok/prompt-library