FLUID-5791: Create markdown pages on the new documentation site to describe core Infusion APIs

Metadata

Source
FLUID-5791
Type
Task
Priority
Major
Status
Closed
Resolution
Fixed
Assignee
Antranig Basman
Reporter
Antranig Basman
Created
2015-10-13T16:28:40.041-0400
Updated
2017-02-27T15:49:11.263-0500
Versions
  1. 2.0
Fixed Versions
N/A
Component
  1. Tech. Documentation

Description

We need to get documentation for the core Infusion APIs, especially those in Fluid.js onto the new docs site, as well as document the contents of FluidPromises.js which so far have never had docs.

It looks like it will be best to do this by hand, and produce some docs broadly similar to, say, those which are widely deployed for modules like node's - for example, https://github.com/nodejs/node/blob/master/doc/api/http.markdown

FLUID-5461 contains a helpful, but old review of what docs we had at 1.5 which in this area has not changed much