Chart.js: [FEATURE] Better Documentation / Wiki Detailing Option Parameters and Properties

[own3mall]

The documentation provided on the Chart.js website is incomplete and lacking. Is there a page anywhere where each object and property that Chart.js supports is documented with possible values?

Kendo does a much better job of documenting their chart properties, objects, and functionality. See here:

http://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/chart

Is there any documentation that currently exists that breaks down each method, property (including which values it supports), which data formats are supported, etc?

Expected Behavior

Documentation that breaks down every single option and possible value available to developers.

Current Behavior

Searching the documentation usually results in limited examples with little to no explanation or break down of possible values.

Possible Solution

Build a page similar to Kendo's (linked above)

Context

When trying to render a specific chart, I usually have to search Google to see if someone has an example, and usually, these examples don't meet my needs. Unfortunately, the current documentation doesn't seem to explain much.

http://www.chartjs.org/docs/latest/

[andig]

I'd also propose to add a developers section to the docs that gives a rough understanding of the overall rendering flow and the components involved to make chartjs easier accessible for new contributors.

[etimberg]

@andig I'm happy to look at a PR for that. There is already a developer page where it could live.

As to the original comment, all of the options are detailed in the tables on each page including the type of the option and a description of what it does. I am happy to look at PRs that improve specific sections however simply telling us that it sucks is not very helpful.

[andig]

@etimberg

I am happy to look at PRs that improve specific sections however simply telling us that it sucks is not very helpful.

Full ack. My point was that- before contributing to anything- I'd need to figure out where to start ;) E.g. flot has good docs about the general flow and phases of the rendering process.

[etimberg]

@andig I totally get that. I will open an issue to track adding that information; I just don't think this issue is the right place to capture that information.

[own3mall]

I never said it sucked, but I cannot find ALL of the options that ChartJS supports. The documentation is very difficult to use, is nested in multiple pages and sections which do NOT list all supported data formats, available properties, support values, and more.

Again, I believe Telerik's documentation is a fine example of what developers are looking for when using any library.