One other issue, that I’ve just been reminded of, is that the documentation doesn’t really link well together as it currently is. I already gave my example regarding DataStore and its information. But I’ve just discovered a different kind of example. When there are things that are related to each other, but from a different service.
For example, plugin:OpenScript() is now deprecated, and yet it fails to link the replacement, which is ScriptEditorService:OpenScriptDocumentAsync().
Additionally, I was unable to find this information in the search either:
The closest thing here was ScriptDocument in the second search, but that’s not actually what I’m looking for either.
There are many cases like this where there the API is spread far apart and not linked together. I can’t think of all of them off the top of my head right now, but it’s most common when things are moved to their own unique services. The different plugin features alone seem to have multiple different services that are completely outside of plugin itself.
Another example is Selection, instead of having it in plugin, which already has methods like SelectRibbonTool (which while not exactly the same, you might see the confusion). There should be central documentation for plugins, which links all of the different connected services that you would need to know about. The same should be done for any other group of API that are spread out across multiple different services.
I wish I had a full list of examples to make my point clear. Maybe others could add to this list if they can think of any.
Additionally, an easy and important thing to fix would be to look at everything that’s deprecated and making sure that it links to its replacement, if such a replacement exists.
I did also try the AI assistant for what the replacement was, but it gave me methods for creating new windows rather than what I specifically asked for. I tried ChatGPT and, while it didn’t give me the correct method, it did point me to the right service for it. While I’ve used this service before, it’s been a long time and I had forgotten about it. The documentation search wasn’t able to help me find what I was looking for. It didn’t even show the the deprecated version (which I can understand, but it didn’t show me the replacement for it either).