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:
keep all documentation up-to-date in documentation in the project's main branches
use the gh-pages branch as a way to market the framework and its main features, but leave full documentation to the documentation directory in the other branches
keep the pattern primer in Assets/src/templates and eliminate the one in documentation, meaning the link to pattern primer in documentation/index.html will need to be updated to point to the PHP file in the root.
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.
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 thedocumentation/index.html
anddocumentation/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:documentation
in the project's main branchesdocumentation
directory in the other branchesAssets/src/templates
and eliminate the one indocumentation
, meaning the link to pattern primer indocumentation/index.html
will need to be updated to point to the PHP file in the root.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.