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

Documentation updates #3110

Merged
merged 3 commits into from
Aug 10, 2016
Merged

Documentation updates #3110

merged 3 commits into from
Aug 10, 2016

Conversation

panzarino
Copy link
Contributor

@panzarino panzarino commented Aug 8, 2016

Adds a lot of new information to the docs that will help developers better utilize the entire Chart.js library

List of implemented changes:

The merge conflicts can be easily resolved through a command line merge, so do not worry about that.

Adds a lot of new information to the docs that will help developers better utilize the entire Chart.js library

List of implemented changes:
 - Reverse option for legends (resolves #3102)
 - Information about chart resizing (resolves #3023)
 - Mixed chart types (resolves #2825) (resolves #2431)
 - Chart library comparison table (resolves #2605)
 - getDetasetMeta function information (resolves #2521)
 - Popular Extensions (resolves #2365)
@etimberg
Copy link
Member

etimberg commented Aug 8, 2016

+1 to merge

@panzarino
Copy link
Contributor Author

Should I go ahead and merge this?

CC: @simonbrunel

@jakesylvestre
Copy link
Contributor

+1 on merge

@@ -134,3 +135,5 @@ var myChart = new Chart(ctx, {
```

It's that easy to get started using Chart.js! From here you can explore the many options that can help you customise your charts with scales, tooltips, labels, colors, custom actions, and much more.

There are many examples of Chart.js that are available in the [samples folder](https://github.com/chartjs/Chart.js/tree/master/samples) of the GitHub repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since samples in the repo don't work without a gulp build first (and because we encourage users to not clone/download the repository), it may be better to write about the Chart.js.zip attached to releases containing built examples in the samples/ folder.

@simonbrunel
Copy link
Member

We should remove the Advanced section from the user documentation and start a GH wiki to store all that developer stuff (and add a link from the user doc to that wiki). It would make the doc lighter and would allow us to write much more code related stuff (such as coding standards, release process, etc.). I would also move the Contributing section to the wiki.

@panzarino
Copy link
Contributor Author

I have updated the changes and added a plugin section.

@panzarino panzarino merged commit 57f2d7d into chartjs:master Aug 10, 2016
panzarino added a commit that referenced this pull request Aug 10, 2016
@panzarino panzarino deleted the docs branch August 10, 2016 00:14
exwm pushed a commit to exwm/Chart.js that referenced this pull request Apr 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment