My initial thoughts on this are that contribution guidelines could add unnecessary clutter to the docs. My guess is that the ratio of users to those looking to contribute is probably tiny (100:1, if that). The primary use of epiceditor.com in my mind is to "sell" the concept and provide basic usage and API. It's a resource for users more than contributors and keeping it restricted to this I think might help searchability and readabilty. As a front-end project, many users may not even be familiar with github beyond a resource for code. Those who are interested should have no problem finding the repo on github via the fork ribbon, or the contributions wiki page already linked. On another level, leaving contribution guidelines to the wiki further encourages contributions as users can directly contribute to the wiki w/o pull requests (e.g. create a page called "Easy jQuery Integration", or "Extending Marked" etc). These types of pages are perfect for the wiki and don't require pull requests or builds to modify. API documentation, however, is directly related to the build - as API changes, docs change. Does this make sense? Thoughts?
Created
May 12, 2012 20:29
-
-
Save johnmdonahue/2668813 to your computer and use it in GitHub Desktop.
RE: Moving EpicEditor wiki pages to docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Very good points. I totally agree. It shall stay a wiki!
Also, side note, I made some updates to that wiki page after Adam was have a bit of trouble.