Documentation generator

[shaqq]

Here's what the generated README would look like

I wanted to auto-generate the Endpoints from rake routes, but Thor doesn't seem to load the ApplicationApi

[shaqq]

@danielmackey @ckampfe @jdoconnor @darbyfrey @umtrey @ajself @kevinreedy

[umtrey]

When we generate a new napa service, a README is generated that's just really basic. Is there any reason we wouldn't want that to be replaced by the new README from here?

[umtrey]

Generating a readme in a non-root path will create a spec folder in the given path as well - probably need to make sure we put the test file in there.

[shaqq]

@umtrey I think the idea is to replace the default README with this one (though maybe we would tone down the pooping a bit) - it's not too hard to move this over to the scaffold generator.

Originally I had plans of making something more rdoc-y that would auto-generate certain parts of the README. But, that's a little further down I think.

[shaqq]

I think there's also the danger of yelling at the user too fast - the readme generator creates a breaking test right off the bat. Sometimes people fill out README's a little later on, and this is somewhat of a more guided process.

[umtrey]

Let's add in a note in the quickstart about making sure they generate a readme (and also update the base gem readme too with the new command), then it's on their terms.

[shaqq]

@darbyfrey do you think adding a spec for the README might be too much?

[heymackey]

Can we make it a pending spec?

[umtrey]

@danielmackey

[darbyfrey]

a pending test seems like a good solution to me

[shaqq]

So, what does everyone think about the :poop:? I thought it was funny at first, but it might be a little on the nose for someone who doesn't work at Belly.

[shaqq]

@darbyfrey @danielmackey @umtrey I'll switch that test to pending, and update the quickstart & gem readme

[umtrey]

@shaqq just one poo very early in the README would be cute, but no need for more than that - they very well could gut the rest of the README.

[shaqq]

Check out the toned-down version

[ckampfe]

"Diagrams and pictures are :angel:"

[heymackey]

     /(|
    (  :
   __\  \  _____
 (____)  `|
(____)|   |
 (____).__|
  (___)__.|_____

[heymackey]

The other alternative is to use the :x: emoji, if we want something more 'corporate'

[shaqq]

@darbyfrey @jdoconnor wanna do a quick look on the nicer version of the docs?

https://github.com/shaqq/readme-example/blob/master/README.md

[umtrey]

@shaqq make sure to put a note in the napa readme about the new readme generator

[darbyfrey]

Looks good. Please add this to the CHANGELOG as well.

+:bow:

[umtrey]

+1 so excite