Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation for custom charts #168

Open
martin-smith opened this issue Nov 19, 2023 · 0 comments
Open

Better documentation for custom charts #168

martin-smith opened this issue Nov 19, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@martin-smith
Copy link

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[X ] Documentation issue or request
[ ] Other... Please describe:

Current behavior

Currently in the docs there is little in the way of semi advanced custom charts.
The documentation only has simple charts and then jumps immediately to the complex radar example

Expected behavior

What would be ideal is a series of documentation detailing almost "my first" custom charts. Likely covering the below topics

  1. X/Y scaling -> or linking to other references (as the current docs doesn't really explain)
  2. Simple example for instance a simple BarSeries joined with a simple LineSeries - eg data with trendline
  3. How axis work in relation to custom charts

What is the motivation / use case for changing the behavior?

This small amount of documentation would help bridge the gap for novice users, as whilst the library is very powerful it has a steep learning curve outside of simple usage. Furthermore as this library is not super well used there is practically zero support on places such as reddit or stackoverflow.

@amcdnl amcdnl added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants