chartjs / chartjs/Chart.js

Link to documentation in samples

Open
#10,295 8 comments 0 reactions 0 assignees View on GitHub
type: documentation
Dominant language
JavaScript
Stars
67.7k
Forks
11.9k
Avg merge
7h 39m
Merged PRs (30d)
5

Description

### Documentation Is:

- [X] Missing or needed?
- [ ] Confusing
- [ ] Not sure?

### Please Explain in Detail...

It would be useful if every sample had links to relevant documentation.

I'd be willing to contribute a first draft for every sample if you decide this is a good idea. Just need to know what the template would be before changing a bunch of files. [Put docs section at the top or at the bottom?]

### Your Proposal for Changes

I'd expect https://www.chartjs.org/docs/latest/samples/line/stepped.html to display something like

> ## Docs
> * [Line](https://www.chartjs.org/docs/latest/charts/line.html)
> * [Stepped](https://www.chartjs.org/docs/latest/charts/line.html#stepped)

And for https://www.chartjs.org/docs/latest/samples/scales/time-max-span.html :

> ## Docs
> * [Line](https://www.chartjs.org/docs/latest/charts/line.html)
> * [`spanGaps`](https://www.chartjs.org/docs/latest/charts/line.html#line-styling)
> * [Time Scale](https://www.chartjs.org/docs/latest/axes/cartesian/time.html)

### Example

_No response_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.