generator-react-zeal icon indicating copy to clipboard operation
generator-react-zeal copied to clipboard

Generate a README with common documentation

Open rwilcox opened this issue 7 years ago • 4 comments

I was recently given a project that contained a front end generated by the React Zeal generator.

This project (which contained the Zeal application embedded in a Rails app) posted many difficulties in getting the application up, and obviously your generator contains some nicities that I would have had to find purely by reverse engineering the application. (ie theming).

(I'm sure you can figure out what those difficulties were by looking at the readme and seeing where that leans ;) )

By pure luck I managed to find that this was automatically generated code, not artisanally, handcrafted code, and that this was the source code for that generator!

My patch adds a README.md to the client folder, such that every new project generated will have some idea about origin of the code, getting-it-up-on-my-machine concerns, and other potentially common problems that may technically be the domain of downstream projects, but are worth documenting here as a one stop shop).

Of course, as generated code, the user is free to delete the README or repurpose it, like so many README files in so many Rails generated projects.

Also, say hi to Frank for me. ;-)

rwilcox avatar Dec 23 '17 18:12 rwilcox

Hey @rwilcox, wanted to touch base with you to let you know we are reviewing this alongside the feedback that you will be providing in other formats. We will wait to get that information in our hand and reach out.

frank-west-iii avatar Dec 27 '17 20:12 frank-west-iii

Hello again @rwilcox, after reviewing this and the other feedback we certainly see where some of the confusion is and having a README generated pointing back to this repo would be extremely helpful.

This PR needs some tweaking in terms of our company voice. We're going to have a team member review and provide feedback. Let us know if you want to work with us on this PR to make those adjustments.

Cheers

frank-west-iii avatar Jan 04 '18 15:01 frank-west-iii

Yes, please keep me in the loop / tag me in your PR revision!

rwilcox avatar Jan 05 '18 14:01 rwilcox

@rwilcox - This is quite a late follow-up, but we will be reviewing your changes and working towards getting in your requested changes for better docs. Thank you for taking the time to help out!

sturdynut avatar Oct 02 '20 23:10 sturdynut