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.

Sign up for GitHub

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

Jump to bottom

Update readme links and bug issue template #8693

Merged
merged 1 commit into from Apr 2, 2021
Merged

Update readme links and bug issue template #8693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG.md
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@ labels: 'type: bug'
Bug reports MUST be submitted with an interactive example:
https://codepen.io/pen?template=JXVYzq

Chart.js 1.x is NOT supported anymore, new issues will be disregarded.
Chart.js versions lower then 3.x are NOT supported anymore, new issues will be disregarded.
-->

## Expected Behavior
Expand Down
21 changes: 9 additions & 12 deletions README.md
View file
Open in desktop
Expand Up @@ -13,23 +13,20 @@

## Documentation

Currently, there are two versions of the library (2.9.4 and 3.x.x). Version 2 is the latest stable version while 3 is the next (currently beta) version. As such bear the following in mind:

* Current docs points to version 2.9.4
* Npm/CDN/etc point to version 2.9.4 (unless you explicitly set newer version, e.g. npm next)
* Source currently points to 3.x.x version. 2.9.4 source is available [here](https://github.com/chartjs/Chart.js/tree/2.9)
* Docs for version 3.x.x are available [here](https://www.chartjs.org/docs/master/)
All the links point to the new version 3 of the lib.

* [Introduction](https://www.chartjs.org/docs/latest/)
* [Getting Started](https://www.chartjs.org/docs/latest/getting-started/)
* [General](https://www.chartjs.org/docs/latest/general/)
* [Configuration](https://www.chartjs.org/docs/latest/configuration/)
* [Charts](https://www.chartjs.org/docs/latest/charts/)
* [Axes](https://www.chartjs.org/docs/latest/axes/)
* [Developers](https://www.chartjs.org/docs/latest/developers/)
* [Getting Started](https://www.chartjs.org/docs/latest/getting-started/index)
* [General](https://www.chartjs.org/docs/latest/general/data-structures)
* [Configuration](https://www.chartjs.org/docs/latest/configuration/index)
* [Charts](https://www.chartjs.org/docs/latest/charts/line)
* [Axes](https://www.chartjs.org/docs/latest/axes/index)
* [Developers](https://www.chartjs.org/docs/latest/developers/index)
* [Popular Extensions](https://github.com/chartjs/awesome)
* [Samples](https://www.chartjs.org/samples/)

In case you are looking for the docs of version 2, you will have to specify the specific version in the url like this: [https://www.chartjs.org/docs/2.9.4/](https://www.chartjs.org/docs/2.9.4/)

## Contributing

Instructions on building and testing Chart.js can be found in [the documentation](https://www.chartjs.org/docs/master/developers/contributing/#building-and-testing). Before submitting an issue or a pull request, please take a moment to look over the [contributing guidelines](https://www.chartjs.org/docs/master/developers/contributing/) first. For support, please post questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/chartjs) with the `chartjs` tag.
Expand Down