No docs on CSS aspects

Bug #1315505 reported by Kyle Nitzsche
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Ubuntu HTML5 UI SDK
Triaged
High
Unassigned

Bug Description

Many aspects of the Ubuntu HTML5 framework are only touched by our CSS (for example toggles).

There are no docs for these things. We nether explain how to declare them, nor what styles are available or what the styles mean and do.

The is arguably a part of our API.

Do we need a method for generating API docs from CSS?

Revision history for this message
JoshuaStrobl (joshua.strobl) wrote :

Hello,

I approached Kyle with a blog post I wrote where I pointed out the lack of any documentation on toggles, despite them being shown in Ubuntu HTML5 UI Toolkit and in the example HTML5 app that is generated when creating a new project.

Many developers, myself included, follow the guide and don't necessarily create a new project with the example code (since there is already enough example code necessary to compose a fairly decent HTML5 page at http://developer.ubuntu.com/apps/html-5/guides/html5-guide/), so using documented APIs, whether it be Javascript or for UbuntuUI components that are purely defined through CSS and nested HTMLElements, is an integral part of the developer experience.

As part of developing my application, I utilize toggle buttons. In fact, it's really an essential part of the UX, such as settings. Having Toggle buttons documented is absolutely critical.

Thanks for all your hard work and I look forward to progress on the blog,
Joshua

David Barth (dbarth)
tags: added: html5-hotlist
Changed in ubuntu-html5-theme:
status: New → Confirmed
Changed in ubuntu-html5-theme:
status: Confirmed → Triaged
importance: Undecided → High
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.