Uploaded image for project: 'Fluid Infusion'
  1. Fluid Infusion
  2. FLUID-5791

Create markdown pages on the new documentation site to describe core Infusion APIs

    XMLWordPrintable

Details

    • Task
    • Status: Closed
    • Major
    • Resolution: Fixed
    • 2.0
    • None
    • Tech. Documentation
    • None

    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

      Attachments

        Issue Links

          Activity

            People

              antranig Antranig Basman
              antranig Antranig Basman
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: