Boardgame.io: Document AI framework
The documentation for the AI framework is lacking, currently only giving an example of enumerate without giving much context about how to use it. I had to dig into the code to see how and when the bots were instantiated, and what their API was.
jchadwick
All 4 comments
I'm happy to do this, I just wanted to make sure noone else had anything in progress before I started.
jchadwick
on 24 Sep 2019
Ah, this is actually deliberate because the AI "framework" (if it is a framework) is still a young experiment and I'm sure that the API will change many times before it is ready for wider reception.
nicolodavis
on 24 Sep 2019
But perhaps having some documentation will help increase adoption which will further help shape the API. So, I'm not fundamentally opposed to having a page about the AI in either the Guides or the Reference section.
nicolodavis
on 24 Sep 2019
That's fair, but in the limited scenarios I've put it through what's there seems to work pretty well. I think it's ok for the documentation to change and mature with the API. More importantly, documentation might get more people using it and more feedback as to what the API should be?
jchadwick
on 24 Sep 2019
Related issues
julienroulle
路
9Comments
amerine
路
5Comments
jstacoder
路
7Comments
eseom
路
4Comments
adngdb
路
5Comments
Most helpful comment
That's fair, but in the limited scenarios I've put it through what's there seems to work pretty well. I think it's ok for the documentation to change and mature with the API. More importantly, documentation might get more people using it and more feedback as to what the API should be?