Skip to content
This repository was archived by the owner on Feb 26, 2022. It is now read-only.

Documentation Todo

caseyamcl edited this page Jul 5, 2012 · 1 revision

To-Do:

The Upload Library now fails on tests. Need to finish conding the Strategy classes



1. Install Jekyll for generating documentation
2. Setup this folder for Jekyll
3. Build documents in here for the application

Documentation Site Plan:
 - Home (About the project, features, etc)
 - Changelog (A changelog)
 - License (Duh) 

 - Overview -- Overview of the layout of the project
 
 Client
 - Overview - Overview of Javascript and Html Template
 - Template - How to rewrite the template with your own (required elements, etc)
 - Styles - How to manipulate the styles
 - Javascript API

 Server
 - Overview - Overview of the server routes and functions - how to drop-in replacements
 - Hooks - How to use hooks to modify functionality of the application and integrate
 - API Guide - Routes, expected requests and various responses

Clone this wiki locally