connectivedx / Phoenix

http://connectivedx.github.io/Phoenix/
33 stars 5 forks source link

Github.io Docs and Pattern Primer #52

Closed ajmueller closed 9 years ago

ajmueller commented 9 years ago

The github.io docs (http://isitedesign.github.io/Phoenix/) are becoming cumbersome to maintain; they are in the gh-pages branch of the project and contain the full documentation already located in documentation in the project's other branches. Since the gh-pages are hosted on github.io, you can only use HTML and not PHP, so that means copying and editing the documentation/index.html and documentation/pattern-primer.html pages from other branches and updating their paths to fit the needs of the pages on github.io. In addition, we have the pattern primer twice in the main code branches. My recommendations:

What are everyone's thoughts? I'm hoping to make our lives easier in terms of documentation maintenance while making it clear, complete, and easily accessible to developers who are interested in the framework.

ajmueller commented 9 years ago

The gh-pages branch has been drastically simplified, but the pattern primer pages still need to be updated in the main project.