ChartJSBlazor icon indicating copy to clipboard operation
ChartJSBlazor copied to clipboard

Documentation adjustments

Open Joelius300 opened this issue 5 years ago • 2 comments

Here you can find what needs to be done for the documentation (on github).

Require code changes as well

After extracting to own components

We want to do it like the original library. Meaning we create a new shared project where we put all the samples as components. Then we will also add a Blazor (client side) project (besides the current server-side one) so we have samples for both client- and server-side without redundant code. This also allows for more complete testing.

  • [ ] Update LineChart-samples

After rework

  • [ ] BarChart-sample(s)
  • [ ] BubbleChart-sample(s)
  • [ ] ScatterChart-sample(s)
  • [ ] RadarChart-sample(s)
  • [ ] PolarAreaChart-sample(s)
  • [ ] PieChart-sample(s)
  • [ ] MixedChart-sample(s)
  • [ ] DoughnutChart-sample(s)

Pure documentation change

  • [ ] Mention index.html (client side) vs _Host.cshtml (server side). Currently only _Host.cshtml is mentioned. This should be further adjusted once both client- and server-side samples are available.
  • [ ] Mention how to use _content. Also link to the Known-Issues page for server-side static content consumption which is currently unsupported.
  • [ ] Talk about @using ChartJs.Blazor in _Imports.razor (client side) if necessary
  • [x] Fix nuget-link in Wiki
  • [ ] Rework tips in Wiki
  • [x] Fix messed up link tag in ReadMe
  • [ ] Add other option of adding Nuget-package back to readme
  • [x] Format the known-issues page better.

Joelius300 avatar Jul 25 '19 13:07 Joelius300

  • [x] Fixed nuget link in Wiki: https://github.com/Joelius300/ChartJSBlazor/wiki/Getting-Started

What do you mean with Fix messed up link tag in ReadMe?

SeppPenner avatar Aug 13 '19 14:08 SeppPenner

Thank you.

The html-link tag for the highlight.js (css) was messed up (missing <). Since it was removed in https://github.com/Joelius300/ChartJSBlazor/commit/74a9359dbad0f3b153e8ad2bb40c56cbb4979141, I can check this.

EDIT:
Actually I just saw that the link tag in the wiki is messed up as well. I'll remove the highlight.js stuff there as well.

Joelius300 avatar Aug 13 '19 17:08 Joelius300