From Learn About the Ext JavaScript Library

Some time ago I started to look for bugs in Ext's documentation, and posted most of them to the forum. Recently I was offered the possibility of doing those fixes on the source code myself, so now I'm part of the Ext Documentation Team. As a result, I'm getting more interested in the documentation issues surrounding Ext.

This is where I will be gathering useful info and links related to Ext documentation.

(For a compilation of forum links on other aspects of Ext, see the Forum Index.)

Contents 1 Forum posts: Missing and/or incorrect Docs 2 Forum posts: Requests for improving docs 3 Forum posts: The Ext doc parser, and generating docs 4 Other forum threads (about Ext docs in general, not specific classes) 5 Forum posts: Version upgrades 6 User contributed docs & tools 7 JSDoc 8 Docs for other open source projects (possible inspiration?) 8.1 JavaScript frameworks 8.2 Server-side frameworks and languages 9 Some general readings

Forum posts: Missing and/or incorrect Docs

• Bugs > [Closed] Missing and/or incorrect API Docs (1.0-1.0.1)
• Bugs > Missing and/or Incorrect Docs - Ext 1.1 (beta1)+
• Bugs > Missing and/or Incorrect Docs - Ext 1.1 (beta2)+

Forum posts: Requests for improving docs

• Feature Requests > Doc center "feature" requests
• General Discussion > Documentation Ideas.
• Help > Documentation Improvement Suggestion
• General Discussion > ExtJS documentation Wiki?
• Feature Requests > Documentation Improvement
• Help > Better documentation and examples proposal
• General Discussion > documentation recommendations
• Feature Requests > Feature Request: More examples
• General Discussion > Documentation Version on Website

Forum posts: The Ext doc parser, and generating docs

• Help > JSDoc template files
• General Discussion > JSDoc-2
• JS Builder > Documentation center.
• General Discussion > JSDoc - how to generate dynamic documentation out of code
• General Discussion > Which tool is used for generating the Ext API document?
• Premium Help > How to build documentation
• General Discussion > generating docs

Other forum threads (about Ext docs in general, not specific classes)

• Help > The new Documentation Center - Check it out!
• Help > Documentation Center .2 is up!
• Help > How to use documentation
• Prerelease Builds Discussion > API Docs Update
• Help > Struggling with Documentation
• General Discussion > Can't find items in documentation for Ext
• Help > API docs and config options
• General Discussion > Extension of DOCs

Forum posts: Version upgrades

• Prerelease Builds Discussion > How the Ext 1.0 Alpha release impacts your code
• General Discussion > Extension of DOCs

User contributed docs & tools

• Ext JS JavaScript Library Cheat Sheets
• Ext Search (demo by trbs)

JSDoc

• JSDoc - JavaScript Documentation Tool

Docs for other open source projects (possible inspiration?)

JavaScript frameworks

• YUI Library
• Prototype
• Developer Notes for prototype.js
• jQuery
• Dojo
• MochiKit

Server-side frameworks and languages

• Django
• Symfony
• Ruby on Rails
• Spring Framework
• PHP

Some general readings

• Open-source Documentation
• Documentation issues in open source

• Producing Open Source Software: How to Run a Successful Free Software Project, by Karl Fogel. (See TOC.)
• Succeeding with Open Source, by Bernard Golden. Addison Wesley, 2004. Chapter 7, Open Source Documentation.