Labs/Bespin/DesignDocs/Inline Documentation: Difference between revisions

From MozillaWiki
< Labs‎ | Bespin‎ | DesignDocs
Jump to navigation Jump to search
m (Created page with 'We would like to have rich/intuitive inline documentation of web development topics such as HTML, CSS, Javascript and Javascript libraries. This documentation would be included d...')
 
mNo edit summary
Line 1: Line 1:
==Overview==
We would like to have rich/intuitive inline documentation of web development topics such as HTML, CSS, Javascript and Javascript libraries. This documentation would be included directly within the Bespin interface with the goal of making the documentation work offline via Google Gears, HTML client-side storage, or just running Bespin locally.
We would like to have rich/intuitive inline documentation of web development topics such as HTML, CSS, Javascript and Javascript libraries. This documentation would be included directly within the Bespin interface with the goal of making the documentation work offline via Google Gears, HTML client-side storage, or just running Bespin locally.


Line 6: Line 7:


NOTE: It would be nice to collaborate with the Open Web project so as to not duplicate work or fragment mindshare.
NOTE: It would be nice to collaborate with the Open Web project so as to not duplicate work or fragment mindshare.
==Topics==
* [[Labs/Bespin/DesignDocs/Inline Documentation/Canvas|Canvas]] (Feedback appreciated)
* [[Labs/Bespin/DesignDocs/Inline Documentation/Documentation Systems|Documentation Systems]] (Feedback appreciated)
* Deferred for now:
**HTML
**CSS
**JS
**JS Libraries
***Dojo
***jQuery
***Etc.

Revision as of 00:01, 23 May 2009

Overview

We would like to have rich/intuitive inline documentation of web development topics such as HTML, CSS, Javascript and Javascript libraries. This documentation would be included directly within the Bespin interface with the goal of making the documentation work offline via Google Gears, HTML client-side storage, or just running Bespin locally.

Like many things on the project exactly how this will work will come out of experimenting. For now we will build documentation only for the <canvas> element. This will allow us to have a working prototype to build discussions on and also be helpful for people new to working with the <canvas> element.

Please see the Canvas page and Documentation Systems for more details.

NOTE: It would be nice to collaborate with the Open Web project so as to not duplicate work or fragment mindshare.

Topics