Documentation insufficient to understand the toolchain

[hamishwillee]

There is no high level documentation that explains "really" what this tool can do and more important what it cannot do that you might expect from the description "An API for Exposing User Created Web Content" (either here on wiki or on http://cadecairos.github.io/makeapi-docs/ ) . Specifically what does "exposing" mean, and are there any limitations on the source location. What does it output. At the moment I can only guess what this might be useful for from the API docs.

Would be good to have a simple explanation (with diagrams) of the different parts of the solution and perhaps a "worked example" showing a source web and its output documentation.

[cadecairos]

Hi @hamishwillee,

Sorry for not addressing this issue sooner - previously we worked out of Bugzilla, using Github mainly for hosting the code.

The readme file provides a simple overview of what the MakeAPI is:

The MakeAPI is a node.js based service for storing and exposing metadata about user created web content, called "makes". It provides consumers with an API to Create, Update, Delete, and Search for metadata about a make.

We could definitely benefit from more clearly defining the app.