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

add READMEs to blitz recipes #250

Closed
Talor-A opened this issue May 27, 2021 · 5 comments
Closed

add READMEs to blitz recipes #250

Talor-A opened this issue May 27, 2021 · 5 comments
Labels

Comments

@Talor-A
Copy link

Talor-A commented May 27, 2021

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:

## title of the recipe
< explanation of what problem this recipe solves >

## more information
< link to e.g. chakra homepage for chakra-ui recipe >

## contributors
< list of authors >
@MrLeebo
Copy link
Member

MrLeebo commented May 29, 2021

Great idea!

@nsantos16
Copy link

I can take this issue :)

@flybayer
Copy link
Member

@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 :)

@beerose
Copy link
Contributor

beerose commented Oct 5, 2021

Update: only the theme-ui recipe is left :)

@beerose
Copy link
Contributor

beerose commented Oct 5, 2021

Thank you all for your contributions!

@beerose beerose closed this as completed Oct 5, 2021
@itsdillon itsdillon transferred this issue from blitz-js/blitz Jul 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants