If you’ve started using Release 2.0, you’ve probably already seen the new Appcelerator Titanium documentation site, docs.appcelerator.com. Our goal for Release 2.0 focused on improving the Titanium Mobile API documentation, updating and organizing the guides, and making everything easy to find on a single site:
The options to show or hide inherited members and property accessors on the API Docs are still there, but now they’re now in the Show menu over on the right.
The Filter class members box is a very handy way of finding that elusive property or method. You’ll also find an Expand All button if you want to scroll through all of the properties, methods and events without manually expanding each item.
There are still many things to improve, but I’m happy to have the first version of our new doc site in the wild, and I’m proud of the work the documentation team has done over the last six months:
- Completely revised the API docs for about 2/3 of the modules and objects in the Titanium Mobile API.
- Updated existing guides, added new guides sections, and removed obsolete material.
- Fixed almost 300 doc bugs.
We’ve made a good start, but we need your help. If you find a doc that’s wrong or missing information, or if you just feel it could be improved, please let us know. We always encourage filing bugs. For questions and general feedback, feel free to contact myself, Tim Poulsen or Paul Dowsett.
Behind the Scenes
We really liked the navigation in JSDuck, Sencha’s open-source documentation tool, so we used it as the front end for our Titanium documentation site. Our API documentation source format hasn’t changed: API docs are written in the TDoc format we rolled out with Release 1.8. The TDoc tools were designed to generate multiple formats, so we added a generator for JSDuck.
The guides content is authored in our wiki and exported for the doc site using a custom script.
So what’s next for the Appcelerator documentation team? Here’s what we have on our roadmap for 2.1.0:
- Continuing to work through the API pages we didn’t get a chance to revise for 2.0.
- More sample code.
- Improved search for the documentation site.
- Continued bug fixes for the docs and documentation site.
If you’d like to contribute to the Titanium documentation effort, there are many ways to help:
- If you find something wrong, or a page that needs more information, file a bug.
- Take it to the next level and submit a fix for an API doc issue.
- Join the crew: the Appcelerator documentation team is hiring.