britecharts / britecharts/britecharts-react

Update project's documentation

Open
#146 5 comments 3 reactions 0 assignees View on GitHub
docs enhancement help wanted ready to go
Dominant language
JavaScript
Stars
112
Forks
19
PR merge metrics
No merged PRs in 30d

Description

## Expected Behavior

To offer correct and complete documentation on how to use the library.

## Context | Current Behavior

The documentation offers a poor description on how to use the chart components as well on how to use the responsiveness helpers as described in the issue #144.

## Possible Solution

* Update the documentation with correct and tested code.
* Offer correct and easy to find dataset examples to test the charts.
* Offer CommonJS and ES5 examples on how to import and use the components.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.