search

swimlane / ngx-charts

:bar_chart: Declarative Charting Framework for Angular
https://swimlane.github.io/ngx-charts/
MIT License
4.28k stars 1.15k forks source link

The documentation is unclear #1007

Open ac10n opened 5 years ago

ac10n commented 5 years ago

As a moderately experienced angular developer, I struggle to use the documentation of ngx-charts.

For instance, please read the angular material docs: it gives a step-by-step guide of how to setup everything. Docs of ngx-charts fail to do that.

My suggestion is: If there is such a guideline, please link to it from docs, otherwise include these steps in the formal docs.

manast commented 5 years ago

I must agree on this. No documentation on how to integrate the library into your app, no documentation on the name of the different selectors, etc.

ahyangyi commented 5 years ago

Ironically, the best documentation in how to use this library I have found is:

https://github.com/akveo/ngx-admin

giulioprinaricotti commented 5 years ago

Still struggling. Charts documentation doesn't mention basic things like what is the minimum set of options needed between the 40 available of a Line Chart. Library seems great but at the moment is not feasible for production.

inorganik commented 4 years ago

This is a great lib! If you could add the selectors to the docs on each chart that would be huge. I had to inspect the demo markup to get the selector for the chart I needed. Thanks.

Blackscr33n commented 3 years ago

Hey guys, wnated to push this a bit, as of 2021 the documentation is very out of date. The examples are using version 10 and we now have version 18.

Also there is no really easy use case, just the example on stackblitz. As a newby (which I am) I would like to have a nice and understandable documentation on how to add as example a pie-chart to my existing angular app.

Never underestimate the power of a good documentation especially in a open-source project

schattenbrot commented 5 months ago

Good morning!

I also wanted to push this since the documentation and examples use all very outdated and even different versions. The examples still use version 10.1.0 while the documentation just says Primary Version.

The live-demo is using 20.4.1, while the latest one getting shipped by npm is 20.5.0 and seems to match the documented Primary Version despite the missing examples on how to use it.

Just the examples getting updated to version 20.4.1 would be of great help.

The "demo" page is empty and apparently modified the last time 2 years ago. Also the "Sankey diagram chart type" added in version 20.5.0 is mentioned in the change log but entirely missing in the rest of the documentation.