lbod edited this page Sep 1, 2013 · 13 revisions

Welcome to the dapi wiki.

This repository is used to enable viewing Dojo API docs via a browser and allow generating those documents to static HTML.

Why is this needed?

Dojo is a large framework/toolkit and highly modularised, complex inheritance/mixin chains are used (e.g. prototyping) and the functionality this exports per module needs to be displayed in an appropriate manner, in a concise way, relative (e.g. versioning) and simple to discover.

The large amount of information the Dojo API provides means there needs to be a more complex user interface to easily view this information.

This has historically meant using a "tab container" for module information, a tree for the list of modules the API provides and various helper links and icons to compress the information.

Please see the Background of why you would want to locally install and use this repository.