search

davidmann4 / botstack

rapid chatbot development with ruby on rails
127 stars 23 forks source link

docs via repo #37

Open davidmann4 opened 7 years ago

davidmann4 commented 7 years ago

http://yardoc.org/ ?

@pferdefleisch what's a good tool to document rails apps? or should I just add a docs/ folder and put *.MD files into it?

mraaroncruz commented 7 years ago

I believe yard is better for code documentation whereas .md files would be fine for project documentation. I'm not aware of any tools to make it html but since you're probably married to a version control hosting platform, linking to .md files sounds the nicest. And easy enough to convert should you start to care about people viewing them locally or if you move away from a github(lab).