swimlane / ngx-charts

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

ngx-charts documentation is fully broken #841

Open atapas opened 6 years ago

atapas commented 6 years ago

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

Current behavior The documentation is fully broken. Before there used to be clear documentation to understand how to use a chart and even to play interactively. At this point documentation is fully blank. https://swimlane.gitbook.io/ngx-charts/examples/bar-charts/vertical-bar-chart

Expected behavior Documentation with example with how to use a chart. What is the selector, properties. A playground to check the code.

Reproduction of the problem Simply go here: https://swimlane.gitbook.io/ngx-charts/examples/bar-charts/vertical-bar-chart

What is the motivation / use case for changing the behavior? Very frustrating not to use the capability of the superb library.

Please tell us about your environment:

marjan-georgiev commented 6 years ago

Please use this link for now: https://swimlane.gitbook.io/ngx-charts/v/docs-test

We are in the process of updating our docs.

atapas commented 6 years ago

Great. Please bring in the examples as we well, as you update.

rlaurente commented 6 years ago

When will you publish the docs ?

takumi-hoppler commented 6 years ago

:(

karocksjoelee commented 6 years ago

document is kind of unclear , I am not sure what to do after I npm install this package

kgrzesiu commented 6 years ago

Documentation is not only broken but sometimes simply not present. E.g. how to use tooltipTemplate and seriesTooltipTemplate. The charts work great but learning how to use them is a huge pain ;(

eruecco87-zz commented 6 years ago

+1 Having to go through source code in the repo is not really ideal and takes up a lot of time.

No idea what the selectors are for a specific chart...

raphael22 commented 6 years ago

Whoa...So we need to crawl issues in order to find a secret doc and then dig in the Plunker to find what is the selector for EACH chart ? What the actual f**k ?

moleskeen commented 5 years ago

Since the documentation is really light at least add some comments in your code!!!