Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 29 lines (20 sloc) 1.315 kb

docs.aerogear.org

This repository contains AeroGear's central documents, wiki pages, roadmaps, and other related project material. Specific component documentation (such as aerogear.js docs) are located within that repository for single point of reference. This repository also contains a centralized build for creation of a single document distribution for the entire project.

All of our documentation is either in standard MarkDown, or AsciiDoc format for consistency.

Top Level Document Folders

  • /guides
    • Tutorials, gettings started docs, how-tos
  • /planning
    • Project roadmaps, plans, etc...
  • /reference
    • Central project reference material (may not be needed)
  • /scratchpad
    • Misc scraps, notes, works in progress, etc...

Central Build Instructions

TODO Define a central build mechanism, starting with aergear.js.

Updating, Contributing Documentation

One of the great things about having our project documentation in git, and in this form is how easy it is to update and contribute to. Please see CONTRIBUTING.md for more information on how to get involved with AeroGear's documentation.

Something went wrong with that request. Please try again.