wiki documentation?

Question

michaelachrisco opened this issue 9 years ago · comments

I have a sample app that we created at a small local competition. I can add the rake task into the docs.

I was wondering what the preference is: Wiki documentation, README, or git-pages?

Chris Metcalf · Answer 1 · Wed Jun 24 2015 06:48:37 GMT+0800 (China Standard Time)

@michaelachrisco Is it a full project or just a Rakefile? If it's just a single file, a Gist + a wiki entry might be appropriate.

Michael Chrisco · Answer 2 · Sat Jun 27 2015 04:45:23 GMT+0800 (China Standard Time)

Ok made the gist real quick. When I get a chance ill add in the wiki description: https://gist.github.com/michaelachrisco/dff796c04701c96c1154

Michael Chrisco · Answer 3 · Wed Jan 06 2016 04:06:56 GMT+0800 (China Standard Time)

Closed as gist takes care of description.

(opinion) README.md and official docs are better for the gem.