ngx-charts documentation is fully broken

Created on 18 May 2018  路  9Comments  路  Source: swimlane/ngx-charts

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

  • [x] bug report - search github for a similar issue or PR before submitting
  • [ ] feature request
  • [ ] support request - use StackOverflow (add the ngx-charts tag) or the gitter chat for support questions

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:

  • ngx-charts version: x.x.x
    5.0.0

  • Angular version: x.x.x
    4.6.3

  • Browser: [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
    All

  • Language: [all | TypeScript X.X | ES6/7 | ES5]
    All

Most helpful comment

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

We are in the process of updating our docs.

All 9 comments

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

We are in the process of updating our docs.

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

When will you publish the docs ?

:(

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

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 ;(

+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...

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 ?

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

Was this page helpful?
0 / 5 - 0 ratings