No information about option's position in the configuration

[fairking]

Documentation Is: https://www.chartjs.org/docs/latest/axes/styling.html#grid-line-configuration

That is just an example, but it is applied to the entire documentation of chartjs.

I am confused every time I look at the documentation because I have no idea where those options need to be placed in the configuration.

For example the following doc:

There is no info where it needs to be placed in chart options.

Please add some short example under the every section. Thanks.

[LeeLenaleee]

It says it in the line. The grid line configuration is nested under the scale config using the gridlines key
So in the config for the scale you nest (add) the gridLines key.

Another example: The legend title config is nested below the legend config using the title key. So to adjust the title props you will have to put it in the title object for the legend in the legend object.

I personally think its pretty clear, only part where I can see it can give confusion is with the legend for example that your first have to look where to put that in the options.

@etimberg @kurkle might it be an idea to instead list it as: The legend title config is nested below the legend config using the title key. To list it as: the legend label config can be adjusted in the options.plugins.legend.title namespace?

If this is a good idea I am willing to make a pr for it

[etimberg]

I would be on-board with that change if it makes it clearer. I would also look at #7367 because in that one the feedback seemed to be that putting the fully qualified name in the table was what users liked the most.

[fairking]

@LeeLenaleee So in the config for the scale you nest (add) the gridLines key.

What is the scale config, where it is??? I tried 'options -> scales -> gridLines' but it does not work. It's completly confising. Can you please show me some example???

Sorry but I don't understand the sentence: The grid line configuration is nested under the scale config using the gridlines key

[LeeLenaleee]

in the scales you have 2 props, an array containing all xAxes axes and all yAxes so to adjust the gridlines for the default x axis you would get:

options: {
  scales: {
   xAxes: [
    {
     gridLines: {
       display: false
      }
    }
   ]
  }
}

[fairking]

@LeeLenaleee alright such example I was missing in the documentation.
Now I understand.
But I spent time to find it out and also wasted your time as well.

[LeeLenaleee]

will try to improve the docs so that it will be better to understand so thanks for the feedback