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

Documentation is not having details like what shold be imported, what are the tags for chart types, having ts, html, css will help much #989

Open syesudas opened 5 years ago

syesudas commented 5 years ago

I'm submitting a ... (check one with "x")

Current behavior The existing documentation at https://swimlane.gitbook.io/ngx-charts/ is not enough for an new Angular developer. It needs lot more R&D to find how to start, what to import, what should go into ts file, what should go into html file, etc.

Expected behavior Please enhance the documentation by showing the ts, html & css code which is used in the demo url https://swimlane.github.io/ngx-charts

Reproduction of the problem Visit the site https://swimlane.gitbook.io/ngx-charts/

What is the motivation / use case for changing the behavior? User friendly documentation

Please tell us about your environment: Windows, NodeJS

paulotokimatu commented 5 years ago

Looks like the documentation site is not working properly right now. The examples are not showing in the pages of each chart. For example, there is no mention of an example in the Heatmap Chart page: https://swimlane.gitbook.io/ngx-charts/examples/heat-map-chart

But in the source there is a link to a plnkr example: https://github.com/swimlane/ngx-charts/blob/master/docs/examples/heat-map-chart.md https://embed.plnkr.co/iyvvzBrEIayRWG5BcQ7e

Anyway, there some broken examples too (at least to me), so it would be good to check that.