Shipped gem should include documentation (guides)
Created by: fwolfst
Continuation from #503 (closed) , @nickcharlton seems to be positive about it too (https://github.com/thoughtbot/administrate/issues/503#issuecomment-285750224).
I opt for including the guides (in /doc
) in the shipped gem. Although they are not necessary for usage, they provide means to access a proper high-level documentation independently from external services (like github, heroku, thoughbot) and internet connectivity.
While optimally the documentation might be included in the documentation that can automatically be built for the gem (rdoc), imho the markdown files are good enough.