Opened 4 years ago

Last modified 23 months ago

#18599 new defect

Improving chart documentation

Reported by: dylan Owned by:
Priority: high Milestone: 1.14
Component: Documentation Version: 1.10.4
Keywords: Cc:
Blocked By: Blocking:

Description

The charting documentation does not do a solid job showing off its capabilities. Some notes:

General reference-guide issues:

  • Bad search: poor location, poor results (try searching on 'charting', 'dojox/charting', 'dojox.charting')
  • Giant scrolling wall of text: breaking things up makes them seem more managable (and navigable)
  • Poor navigation - the TOC is poorly located (kind of an afterthought on the right) and is poorly presented (has the visual style that years of browsing have caused people to perceive as "stuff that doesn't matter"), is inaccessible (scrolls out of view), and has poor interaction (especially for something like charting, which has a lot of navigation - it's all there in a big scrolling list)

Walls of text

Demos

  • Not enough of them organized together to see
  • Do not have modern visual styles
  • Appear to load slow (CodeGlass? is particularly slow with charts)
  • Could provide examples using JSFiddle perhaps?

API viewer

  • So many charting APIs, that it makes it difficult to find stuff

dstore integration

  • No documentation is offered except on the dstore website about the charting connector for use with dstore.

Change History (2)

comment:1 Changed 4 years ago by dylan

Milestone: tbd1.12

comment:2 Changed 23 months ago by dylan

Milestone: 1.131.14
Note: See TracTickets for help on using tickets.