Skip to content

Docs App High Level Overview

Rob Eisenberg edited this page May 1, 2015 · 1 revision

What follows is a very high level overview of the needed documentation app support.

Home Page

An introductory page for the documentations. Welcome message, etc.

Get Started

This is a single page that walks the visitor through creating their first app.

Step-by-Step

An aggregation and ordering of selected How To Articles that take the visitor from the first getting started experience into a deeper knowledge of the framework.

Libraries

A list of all the individual libraries that make up Aurelia. Each library has the following:

Home Page

An introductory page with the following data (extracted from the package.json):

  • Name
  • Description
  • Version, Version Switcher and Change Log Link
  • Tags
  • Issues Link
  • License and Link
  • Repo Link
  • Depends On
  • Used By
  • Exports

API Reference

A class reference. Clicking on a class takes you to the details, where you can see the methods, properties, etc.

  • Class Name
  • Properties
  • Methods
  • Events

Generated from exported JSON data.

How Tos

A list of how to articles.

Written in markdown.