-
-
Notifications
You must be signed in to change notification settings - Fork 2
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
add READMEs to blitz recipes #250
Labels
Comments
Great idea! |
I can take this issue :) |
@nsantos16 yes! There's quite a few recipes, so instead of assigning this to you for all of them, just open PRs for as many/few as you want :) |
3 tasks
This was referenced Sep 29, 2021
3 tasks
This was referenced Oct 2, 2021
Update: only the |
3 tasks
Thank you all for your contributions! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What do you want and why?
it's not very easy to understand what each recipe in the blitz recipe directory does without browsing the source of each one :( . It would be nice to have READMEs in each one, giving a quick overview of what the recipe does and links to more documentation.
As an example,
gh-action-yarn-postgres
: the package.json description (the first place I'd check when I didn't find a README) says "The Blitz Recipe for adding github actions workflow with postgres". How do I know what problem this solves and why I'd want it? (I'm not picking on this recipe specifically, it's just an example). it's not that I can't browse the source and discover what it does, but one of the strengths of blitz is the community's commitment to great (and I mean really, all of the blitz docs are GREAT) documentation, so it feels strange that the recipes don't have individual docs too.Possible implementation(s)
add README.md to each recipe with something like:
The text was updated successfully, but these errors were encountered: