AvaloniaUI / avalonia-docs

https://docs.avaloniaui.net/docs/welcome
65 stars 213 forks source link

Control Names and APIs Should be Proper Names / Nouns #228

Open robloo opened 1 year ago

robloo commented 1 year ago

In all of the existing documentation I see text like "Data Grid" instead of "DataGrid" or DataGrid.

This is a problem for a few reasons:

  1. Control Names and APIs Should be Proper Names / Nouns -- they are used verbatim with the code names
  2. Microsoft's (and almost everyone else's docs) would use "DataGrid" instead of "Data Grid" as well.
  3. Changing the names breaks documentation generation in some cases (which we need to heavily use in the future for properties, etc.)

This is a rather pervasive mistake that's going to take a lot of work to correct...

timunie commented 1 year ago

@robloo I guess the better approach here would be to autogenerate the docs for controls first. Also I agree that for newer docs we need to be more precise when it comes to naming.

robloo commented 1 year ago

@timunie All docs for controls will never be auto-generated I think. However some key pieces can be to start:

Fixing the naming now enables the rest of this. It shouldn't be dependent on it.

MikeCodesDotNET commented 10 months ago

I've begun working on this. Its going to take a while as all the docs seem to refer to the controls by incorrect names.